eventespresso / event-espresso-core

admin_pages/transactions/Transactions_Admin_Page.core.php

Indentation +2518 added lines, -2518 removed lines

@@ -13,2522 +13,2522 @@
  */
 class Transactions_Admin_Page extends EE_Admin_Page
 {
-    /**
-     * @var EE_Transaction
-     */
-    private $_transaction;
-
-    /**
-     * @var EE_Session
-     */
-    private $_session;
-
-    /**
-     * @var array $_txn_status
-     */
-    private static $_txn_status;
-
-    /**
-     * @var array $_pay_status
-     */
-    private static $_pay_status;
-
-    /**
-     * @var array $_existing_reg_payment_REG_IDs
-     */
-    protected $_existing_reg_payment_REG_IDs;
-
-
-    /**
-     *    _init_page_props
-     *
-     * @return void
-     */
-    protected function _init_page_props()
-    {
-        $this->page_slug        = TXN_PG_SLUG;
-        $this->page_label       = esc_html__('Transactions', 'event_espresso');
-        $this->_admin_base_url  = TXN_ADMIN_URL;
-        $this->_admin_base_path = TXN_ADMIN;
-    }
-
-
-    /**
-     *    _ajax_hooks
-     *
-     * @return void
-     */
-    protected function _ajax_hooks()
-    {
-        // add_action('wp_ajax_espresso_apply_payment', [$this, 'apply_payments_or_refunds']);
-        // add_action('wp_ajax_espresso_apply_refund', [$this, 'apply_payments_or_refunds']);
-        // add_action('wp_ajax_espresso_delete_payment', [$this, 'delete_payment']);
-    }
-
-
-    /**
-     *    _define_page_props
-     *
-     * @return void
-     */
-    protected function _define_page_props()
-    {
-        $this->_admin_page_title = $this->page_label;
-        $this->_labels           = [
-            'buttons' => [
-                'add'    => esc_html__('Add New Transaction', 'event_espresso'),
-                'edit'   => esc_html__('Edit Transaction', 'event_espresso'),
-                'delete' => esc_html__('Delete Transaction', 'event_espresso'),
-            ],
-        ];
-    }
-
-
-    /**
-     *        grab url requests and route them
-     *
-     * @access private
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function _set_page_routes()
-    {
-
-        $this->_set_transaction_status_array();
-        $TXN_ID = $this->request->getRequestParam('TXN_ID', 0, 'int');
-
-        $this->_page_routes = [
-
-            'default' => [
-                'func'       => '_transactions_overview_list_table',
-                'capability' => 'ee_read_transactions',
-            ],
-
-            'view_transaction' => [
-                'func'       => '_transaction_details',
-                'capability' => 'ee_read_transaction',
-                'obj_id'     => $TXN_ID,
-            ],
-
-            'send_payment_reminder' => [
-                'func'       => '_send_payment_reminder',
-                'noheader'   => true,
-                'capability' => 'ee_send_message',
-            ],
-
-            'espresso_apply_payment' => [
-                'func'       => 'apply_payments_or_refunds',
-                'noheader'   => true,
-                'capability' => 'ee_edit_payments',
-            ],
-
-            'espresso_apply_refund' => [
-                'func'       => 'apply_payments_or_refunds',
-                'noheader'   => true,
-                'capability' => 'ee_edit_payments',
-            ],
-
-            'espresso_delete_payment' => [
-                'func'       => [$this, 'delete_payment'],
-                'noheader'   => true,
-                'capability' => 'ee_delete_payments',
-            ],
-
-            'espresso_recalculate_line_items' => [
-                'func'       => 'recalculateLineItems',
-                'noheader'   => true,
-                'capability' => 'ee_edit_payments',
-            ],
-
-        ];
-    }
-
-
-    protected function _set_page_config()
-    {
-        $TXN_ID = $this->request->getRequestParam('TXN_ID', 0, 'int');
-        $this->_page_config = [
-            'default'          => [
-                'nav'           => [
-                    'label' => esc_html__('Overview', 'event_espresso'),
-                    'icon' => 'dashicons-list-view',
-                    'order' => 10,
-                ],
-                'list_table'    => 'EE_Admin_Transactions_List_Table',
-                'help_tabs'     => [
-                    'transactions_overview_help_tab'                       => [
-                        'title'    => esc_html__('Transactions Overview', 'event_espresso'),
-                        'filename' => 'transactions_overview',
-                    ],
-                    'transactions_overview_table_column_headings_help_tab' => [
-                        'title'    => esc_html__('Transactions Table Column Headings', 'event_espresso'),
-                        'filename' => 'transactions_overview_table_column_headings',
-                    ],
-                    'transactions_overview_views_filters_help_tab'         => [
-                        'title'    => esc_html__('Transaction Views & Filters & Search', 'event_espresso'),
-                        'filename' => 'transactions_overview_views_filters_search',
-                    ],
-                ],
-                'require_nonce' => false,
-            ],
-            'view_transaction' => [
-                'nav'       => [
-                    'label'      => esc_html__('View Transaction', 'event_espresso'),
-                    'icon' => 'dashicons-cart',
-                    'order'      => 5,
-                    'url'        => $TXN_ID
-                        ? add_query_arg(['TXN_ID' => $TXN_ID], $this->_current_page_view_url)
-                        : $this->_admin_base_url,
-                    'persistent' => false,
-                ],
-                'help_tabs' => [
-                    'transactions_view_transaction_help_tab'                                              => [
-                        'title'    => esc_html__('View Transaction', 'event_espresso'),
-                        'filename' => 'transactions_view_transaction',
-                    ],
-                    'transactions_view_transaction_transaction_details_table_help_tab'                    => [
-                        'title'    => esc_html__('Transaction Details Table', 'event_espresso'),
-                        'filename' => 'transactions_view_transaction_transaction_details_table',
-                    ],
-                    'transactions_view_transaction_attendees_registered_help_tab'                         => [
-                        'title'    => esc_html__('Attendees Registered', 'event_espresso'),
-                        'filename' => 'transactions_view_transaction_attendees_registered',
-                    ],
-                    'transactions_view_transaction_views_primary_registrant_billing_information_help_tab' => [
-                        'title'    => esc_html__('Primary Registrant & Billing Information', 'event_espresso'),
-                        'filename' => 'transactions_view_transaction_primary_registrant_billing_information',
-                    ],
-                ],
-                'qtips'     => ['Transaction_Details_Tips'],
-                'metaboxes' => ['_transaction_details_metaboxes'],
-
-                'require_nonce' => false,
-            ],
-        ];
-    }
-
-
-    /**
-     * The below methods aren't used by this class currently
-     */
-    protected function _add_screen_options()
-    {
-        // noop
-    }
-
-
-    protected function _add_feature_pointers()
-    {
-        // noop
-    }
-
-
-    public function admin_init()
-    {
-        $EVT_ID = $this->request->getRequestParam('EVT_ID', 0, 'int');
-        $event_name = $this->request->getRequestParam('event_name');
-        $redirect_from = $this->request->getRequestParam('redirect_from', '', 'url');
-        // IF a registration was JUST added via the admin...
-        if ($EVT_ID && $event_name && $redirect_from) {
-            // then set a cookie so that we can block any attempts to use
-            // the back button as a way to enter another registration.
-            setcookie('ee_registration_added', $EVT_ID, time() + WEEK_IN_SECONDS, '/');
-            // and update the global
-            $_COOKIE['ee_registration_added'] = $EVT_ID;
-        }
-        EE_Registry::$i18n_js_strings['invalid_server_response'] = esc_html__(
-            'An error occurred! Your request may have been processed, but a valid response from the server was not received. Please refresh the page and try again.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['error_occurred']          = esc_html__(
-            'An error occurred! Please refresh the page and try again.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['txn_status_array']        = self::$_txn_status;
-        EE_Registry::$i18n_js_strings['pay_status_array']        = self::$_pay_status;
-        EE_Registry::$i18n_js_strings['payments_total']          = esc_html__('Payments Total', 'event_espresso');
-        EE_Registry::$i18n_js_strings['transaction_overpaid']    = esc_html__(
-            'This transaction has been overpaid ! Payments Total',
-            'event_espresso'
-        );
-    }
-
-
-    public function admin_notices()
-    {
-        // noop
-    }
-
-
-    public function admin_footer_scripts()
-    {
-        // noop
-    }
-
-
-    /**
-     * _set_transaction_status_array
-     * sets list of transaction statuses
-     *
-     * @access private
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _set_transaction_status_array()
-    {
-        self::$_txn_status = EEM_Transaction::instance()->status_array(true);
-    }
-
-
-    /**
-     * get_transaction_status_array
-     * return the transaction status array for wp_list_table
-     *
-     * @access public
-     * @return array
-     */
-    public function get_transaction_status_array()
-    {
-        return self::$_txn_status;
-    }
-
-
-    /**
-     *    get list of payment statuses
-     *
-     * @access private
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _get_payment_status_array()
-    {
-        self::$_pay_status                      = EEM_Payment::instance()->status_array(true);
-        $this->_template_args['payment_status'] = self::$_pay_status;
-    }
-
-
-    /**
-     *    _add_screen_options_default
-     *
-     * @access protected
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _add_screen_options_default()
-    {
-        $this->_per_page_screen_option();
-    }
-
-
-    /**
-     * load_scripts_styles
-     *
-     * @access public
-     * @return void
-     */
-    public function load_scripts_styles()
-    {
-        // enqueue style
-        wp_register_style(
-            'espresso_txn',
-            TXN_ASSETS_URL . 'espresso_transactions_admin.css',
-            [],
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('espresso_txn');
-        // scripts
-        wp_register_script(
-            'espresso_txn',
-            TXN_ASSETS_URL . 'espresso_transactions_admin.js',
-            [
-                'ee_admin_js',
-                'ee-datepicker',
-                'jquery-ui-datepicker',
-                'jquery-ui-draggable',
-                'ee-dialog',
-                'ee-accounting',
-                'ee-serialize-full-array',
-            ],
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_enqueue_script('espresso_txn');
-    }
-
-
-    /**
-     *    load_scripts_styles_view_transaction
-     *
-     * @access public
-     * @return void
-     */
-    public function load_scripts_styles_view_transaction()
-    {
-        // styles
-        wp_enqueue_style('espresso-ui-theme');
-    }
-
-
-    /**
-     *    load_scripts_styles_default
-     *
-     * @access public
-     * @return void
-     */
-    public function load_scripts_styles_default()
-    {
-        // styles
-        wp_enqueue_style('espresso-ui-theme');
-    }
-
-
-    /**
-     *    _set_list_table_views_default
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_list_table_views_default()
-    {
-        $this->_views = [
-            'all'        => [
-                'slug'  => 'all',
-                'label' => esc_html__('View All Transactions', 'event_espresso'),
-                'count' => 0,
-            ],
-            'abandoned'  => [
-                'slug'  => 'abandoned',
-                'label' => esc_html__('Abandoned Transactions', 'event_espresso'),
-                'count' => 0,
-            ],
-            'incomplete' => [
-                'slug'  => 'incomplete',
-                'label' => esc_html__('Incomplete Transactions', 'event_espresso'),
-                'count' => 0,
-            ],
-        ];
-        if (
-            /**
-             * Filters whether a link to the "Failed Transactions" list table
-             * appears on the Transactions Admin Page list table.
-             * List display can be turned back on via the following:
-             * add_filter(
-             *     'FHEE__Transactions_Admin_Page___set_list_table_views_default__display_failed_txns_list',
-             *     '__return_true'
-             * );
-             *
-             * @param boolean                 $display_failed_txns_list
-             * @param Transactions_Admin_Page $this
-             * @since 4.9.70.p
-             */
-            apply_filters(
-                'FHEE__Transactions_Admin_Page___set_list_table_views_default__display_failed_txns_list',
-                false,
-                $this
-            )
-        ) {
-            $this->_views['failed'] = [
-                'slug'  => 'failed',
-                'label' => esc_html__('Failed Transactions', 'event_espresso'),
-                'count' => 0,
-            ];
-        }
-    }
-
-
-    /**
-     * _set_transaction_object
-     * This sets the _transaction property for the transaction details screen
-     *
-     * @access private
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function _set_transaction_object()
-    {
-        if ($this->_transaction instanceof EE_Transaction) {
-            return;
-        } //get out we've already set the object
-
-        $TXN_ID = $this->request->getRequestParam('TXN_ID', 0, 'int');
-
-        // get transaction object
-        $this->_transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
-        $this->_session     = $this->_transaction instanceof EE_Transaction
-            ? $this->_transaction->session_data()
-            : null;
-        if ($this->_transaction instanceof EE_Transaction) {
-            $this->_transaction->verify_abandoned_transaction_status();
-        }
-
-        if (! $this->_transaction instanceof EE_Transaction) {
-            $error_msg = sprintf(
-                esc_html__(
-                    'An error occurred and the details for the transaction with the ID # %d could not be retrieved.',
-                    'event_espresso'
-                ),
-                $TXN_ID
-            );
-            EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-    }
-
-
-    /**
-     *    _transaction_legend_items
-     *
-     * @access protected
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _transaction_legend_items()
-    {
-        EE_Registry::instance()->load_helper('MSG_Template');
-        $items = [];
-
-        if (
-            EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_global_messages',
-                'view_filtered_messages'
-            )
-        ) {
-            $related_for_icon = EEH_MSG_Template::get_message_action_icon('see_notifications_for');
-            if (
-                is_array($related_for_icon)
-                && isset($related_for_icon['css_class'], $related_for_icon['label'])
-            ) {
-                $items['view_related_messages'] = [
-                    'class' => $related_for_icon['css_class'],
-                    'desc'  => $related_for_icon['label'],
-                ];
-            }
-        }
-
-        $items = apply_filters(
-            'FHEE__Transactions_Admin_Page___transaction_legend_items__items',
-            array_merge(
-                $items,
-                [
-                    'view_details'          => [
-                        'class' => 'dashicons dashicons-cart',
-                        'desc'  => esc_html__('View Transaction Details', 'event_espresso'),
-                    ],
-                    'view_invoice'          => [
-                        'class' => 'dashicons dashicons-media-spreadsheet',
-                        'desc'  => esc_html__('View Transaction Invoice', 'event_espresso'),
-                    ],
-                    'view_receipt'          => [
-                        'class' => 'dashicons dashicons-text-page',
-                        'desc'  => esc_html__('View Transaction Receipt', 'event_espresso'),
-                    ],
-                    'view_registration'     => [
-                        'class' => 'dashicons dashicons-clipboard',
-                        'desc'  => esc_html__('View Registration Details', 'event_espresso'),
-                    ],
-                    'payment_overview_link' => [
-                        'class' => 'dashicons dashicons-money',
-                        'desc'  => esc_html__('Make Payment on Frontend', 'event_espresso'),
-                    ],
-                ]
-            )
-        );
-
-        if (
-            EEH_MSG_Template::is_mt_active('payment_reminder')
-            && EE_Registry::instance()->CAP->current_user_can(
-                'ee_send_message',
-                'espresso_transactions_send_payment_reminder'
-            )
-        ) {
-            $items['send_payment_reminder'] = [
-                'class' => 'dashicons dashicons-email-alt',
-                'desc'  => esc_html__('Send Payment Reminder', 'event_espresso'),
-            ];
-        } else {
-            $items['blank*'] = [
-                'class' => '',
-                'desc'  => '',
-            ];
-        }
-        $more_items = apply_filters(
-            'FHEE__Transactions_Admin_Page___transaction_legend_items__more_items',
-            [
-                'overpaid'   => [
-                    'class' => 'ee-status-legend ee-status-bg--' . EEM_Transaction::overpaid_status_code,
-                    'desc'  => EEH_Template::pretty_status(
-                        EEM_Transaction::overpaid_status_code,
-                        false,
-                        'sentence'
-                    ),
-                ],
-                'complete'   => [
-                    'class' => 'ee-status-legend ee-status-bg--' . EEM_Transaction::complete_status_code,
-                    'desc'  => EEH_Template::pretty_status(
-                        EEM_Transaction::complete_status_code,
-                        false,
-                        'sentence'
-                    ),
-                ],
-                'incomplete' => [
-                    'class' => 'ee-status-legend ee-status-bg--' . EEM_Transaction::incomplete_status_code,
-                    'desc'  => EEH_Template::pretty_status(
-                        EEM_Transaction::incomplete_status_code,
-                        false,
-                        'sentence'
-                    ),
-                ],
-                'abandoned'  => [
-                    'class' => 'ee-status-legend ee-status-bg--' . EEM_Transaction::abandoned_status_code,
-                    'desc'  => EEH_Template::pretty_status(
-                        EEM_Transaction::abandoned_status_code,
-                        false,
-                        'sentence'
-                    ),
-                ],
-                'failed'     => [
-                    'class' => 'ee-status-legend ee-status-bg--' . EEM_Transaction::failed_status_code,
-                    'desc'  => EEH_Template::pretty_status(
-                        EEM_Transaction::failed_status_code,
-                        false,
-                        'sentence'
-                    ),
-                ],
-            ]
-        );
-
-        return array_merge($items, $more_items);
-    }
-
-
-    /**
-     *    _transactions_overview_list_table
-     *
-     * @access protected
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _transactions_overview_list_table()
-    {
-        $this->_admin_page_title = esc_html__('Transactions', 'event_espresso');
-
-        $EVT_ID = $this->request->getRequestParam('EVT_ID', 0, 'int');
-        $event = EEM_Event::instance()->get_one_by_ID($EVT_ID);
-        $this->_template_args['admin_page_header'] = $event instanceof EE_Event
-            ? sprintf(
-                esc_html__('%sViewing Transactions for the Event: %s%s', 'event_espresso'),
-                '<h3>',
-                '<a href="'
-                . EE_Admin_Page::add_query_args_and_nonce(
-                    ['action' => 'edit', 'post' => $event->ID()],
-                    EVENTS_ADMIN_URL
-                )
-                . '" title="'
-                . esc_attr__('Click to Edit event', 'event_espresso')
-                . '">' . $event->name() . '</a>',
-                '</h3>'
-            )
-            : '';
-        $this->_template_args['after_list_table']  = $this->_display_legend($this->_transaction_legend_items());
-        $this->display_admin_list_table_page_with_no_sidebar();
-    }
-
-
-    /**
-     *    _transaction_details
-     * generates HTML for the View Transaction Details Admin page
-     *
-     * @access protected
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws RuntimeException
-     * @throws ReflectionException
-     */
-    protected function _transaction_details()
-    {
-        do_action('AHEE__Transactions_Admin_Page__transaction_details__start', $this->_transaction);
-
-        $this->_set_transaction_status_array();
-
-        $this->_template_args                      = [];
-        $this->_template_args['transactions_page'] = $this->_wp_page_slug;
-
-        $this->_set_transaction_object();
-
-        if (! $this->_transaction instanceof EE_Transaction) {
-            return;
-        }
-
-        $this->_template_args['txn_nmbr']['value'] = $this->_transaction->ID();
-        $this->_template_args['txn_nmbr']['label'] = esc_html__('Transaction Number', 'event_espresso');
-
-        $this->_template_args['txn_datetime']['value'] = $this->_transaction->get_i18n_datetime('TXN_timestamp');
-        $this->_template_args['txn_datetime']['label'] = esc_html__('Date', 'event_espresso');
-
-        $this->_template_args['txn_status']['value'] = self::$_txn_status[ $this->_transaction->status_ID() ];
-        $this->_template_args['txn_status']['label'] = esc_html__('Transaction Status', 'event_espresso');
-        $this->_template_args['txn_status']['class'] = $this->_transaction->status_ID();
-
-        $txn_total  = $this->_transaction->total();
-        $total_paid = $this->_transaction->paid();
-        $amount_due = $txn_total - $total_paid;
-
-        $this->_template_args['grand_total'] = $txn_total;
-        $this->_template_args['total_paid']  = $total_paid;
-
-        $this->_template_args['amount_due'] = EEH_Template::format_currency($amount_due, false, false);
-
-        $this->_template_args['amount_due_class'] = '';
-
-        if ($txn_total === (float) 0) {
-            // free event
-            $this->_template_args['amount_due'] = false;
-        } elseif ($amount_due < (float) 0) {
-            // overpaid
-            $this->_template_args['amount_due_class'] = 'txn-overview-no-payment-spn';
-        } elseif ($amount_due > (float) 0) {
-            // monies owing
-            $this->_template_args['amount_due_class'] = 'txn-overview-part-payment-spn ee-txn-amount-owing';
-        } elseif ($total_paid === (float) 0) {
-            // no payments made yet
-            $this->_template_args['amount_due_class'] = 'txn-overview-no-payment-spn';
-        }
-
-        $payment_method = $this->_transaction->payment_method();
-
-        $this->_template_args['method_of_payment_name'] = $payment_method instanceof EE_Payment_Method
-            ? $payment_method->admin_name()
-            : esc_html__('Unknown', 'event_espresso');
-
-        $this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign;
-        // link back to overview
-        $this->_template_args['txn_overview_url'] = $this->request->getServerParam(
-            'HTTP_REFERER',
-            TXN_ADMIN_URL
-        );
-
-
-        // next link
-        $next_txn                                 = $this->_transaction->next(
-            null,
-            [['STS_ID' => ['!=', EEM_Transaction::failed_status_code]]],
-            'TXN_ID'
-        );
-        $this->_template_args['next_transaction'] = $next_txn
-            ? $this->_next_link(
-                EE_Admin_Page::add_query_args_and_nonce(
-                    ['action' => 'view_transaction', 'TXN_ID' => $next_txn['TXN_ID']],
-                    TXN_ADMIN_URL
-                ),
-                'dashicons dashicons-arrow-right ee-icon-size-22'
-            )
-            : '';
-        // previous link
-        $previous_txn                                 = $this->_transaction->previous(
-            null,
-            [['STS_ID' => ['!=', EEM_Transaction::failed_status_code]]],
-            'TXN_ID'
-        );
-        $this->_template_args['previous_transaction'] = $previous_txn
-            ? $this->_previous_link(
-                EE_Admin_Page::add_query_args_and_nonce(
-                    ['action' => 'view_transaction', 'TXN_ID' => $previous_txn['TXN_ID']],
-                    TXN_ADMIN_URL
-                ),
-                'dashicons dashicons-arrow-left ee-icon-size-22'
-            )
-            : '';
-
-        $EVT_ID        = $this->request->getRequestParam('EVT_ID', 0, 'int');
-        $event_name    = $this->request->getRequestParam('event_name');
-        $redirect_from = $this->request->getRequestParam('redirect_from', '', 'url');
-
-        // were we just redirected here after adding a new registration ???
-        if ($EVT_ID && $event_name && $redirect_from) {
-            if (
-                EE_Registry::instance()->CAP->current_user_can(
-                    'ee_edit_registrations',
-                    'espresso_registrations_new_registration',
-                    $EVT_ID
-                )
-            ) {
-                $this->_admin_page_title .= '<a id="add-new-registration" class="add-new-h2 button--primary" href="';
-                $this->_admin_page_title .= EE_Admin_Page::add_query_args_and_nonce(
-                    [
-                        'page'     => 'espresso_registrations',
-                        'action'   => 'new_registration',
-                        'return'   => 'default',
-                        'TXN_ID'   => $this->_transaction->ID(),
-                        'event_id' => $EVT_ID,
-                    ],
-                    REG_ADMIN_URL
-                );
-                $this->_admin_page_title .= '">';
-
-                $this->_admin_page_title .= sprintf(
-                    esc_html__('Add Another New Registration to Event: "%1$s" ?', 'event_espresso'),
-                    htmlentities(urldecode($event_name), ENT_QUOTES, 'UTF-8')
-                );
-                $this->_admin_page_title .= '</a>';
-            }
-            EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
-        }
-        // grab messages at the last second
-        $this->_template_args['notices'] = EE_Error::get_notices();
-        // path to template
-        $template_path                             = TXN_TEMPLATE_PATH . 'txn_admin_details_header.template.php';
-        $this->_template_args['admin_page_header'] = EEH_Template::display_template(
-            $template_path,
-            $this->_template_args,
-            true
-        );
-
-        // the details template wrapper
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     *        _transaction_details_metaboxes
-     *
-     * @access protected
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws RuntimeException
-     * @throws ReflectionException
-     */
-    protected function _transaction_details_metaboxes()
-    {
-
-        $this->_set_transaction_object();
-
-        if (! $this->_transaction instanceof EE_Transaction) {
-            return;
-        }
-        $this->addMetaBox(
-            'edit-txn-details-mbox',
-            '<span>' . esc_html__('Transaction Details', 'event_espresso')
-            . '&nbsp;<span class="dashicons dashicons-cart" ></span></span>',
-            [$this, 'txn_details_meta_box'],
-            $this->_wp_page_slug
-        );
-        $this->addMetaBox(
-            'edit-txn-attendees-mbox',
-            '<span>' . esc_html__('Attendees Registered in this Transaction', 'event_espresso')
-            . '&nbsp;<span class="dashicons dashicons-groups" ></span></span>',
-            [$this, 'txn_attendees_meta_box'],
-            $this->_wp_page_slug,
-            'normal',
-            'high',
-            ['TXN_ID' => $this->_transaction->ID()]
-        );
-        $this->addMetaBox(
-            'edit-txn-registrant-mbox',
-            esc_html__('Primary Contact', 'event_espresso'),
-            [$this, 'txn_registrant_side_meta_box'],
-            $this->_wp_page_slug,
-            'side'
-        );
-        $this->addMetaBox(
-            'edit-txn-billing-info-mbox',
-            esc_html__('Billing Information', 'event_espresso'),
-            [$this, 'txn_billing_info_side_meta_box'],
-            $this->_wp_page_slug,
-            'side'
-        );
-    }
-
-
-    /**
-     * Callback for transaction actions metabox.
-     *
-     * @param EE_Transaction|null $transaction
-     * @return string
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    public function getActionButtons(EE_Transaction $transaction = null)
-    {
-        $content = '';
-        $actions = [];
-        if (! $transaction instanceof EE_Transaction) {
-            return $content;
-        }
-        /** @var EE_Registration $primary_registration */
-        $primary_registration = $transaction->primary_registration();
-        $attendee             = $primary_registration instanceof EE_Registration
-            ? $primary_registration->attendee()
-            : null;
-
-        if (
-            $attendee instanceof EE_Attendee
-            && EE_Registry::instance()->CAP->current_user_can(
-                'ee_send_message',
-                'espresso_transactions_send_payment_reminder'
-            )
-        ) {
-            $actions['payment_reminder'] =
-                EEH_MSG_Template::is_mt_active('payment_reminder')
-                && $this->_transaction->status_ID() !== EEM_Transaction::complete_status_code
-                && $this->_transaction->status_ID() !== EEM_Transaction::overpaid_status_code
-                    ? EEH_Template::get_button_or_link(
-                        EE_Admin_Page::add_query_args_and_nonce(
-                            [
-                            'action'      => 'send_payment_reminder',
-                            'TXN_ID'      => $this->_transaction->ID(),
-                            'redirect_to' => 'view_transaction',
-                            ],
-                            TXN_ADMIN_URL
-                        ),
-                        esc_html__(' Send Payment Reminder', 'event_espresso'),
-                        'button button--secondary',
-                        'dashicons dashicons-email-alt'
-                    )
-                    : '';
-        }
-
-        if (
-            EE_Registry::instance()->CAP->current_user_can(
-                'ee_edit_payments',
-                'espresso_transactions_recalculate_line_items'
-            )
-        ) {
-            $actions['recalculate_line_items'] = EEH_Template::get_button_or_link(
-                EE_Admin_Page::add_query_args_and_nonce(
-                    [
-                        'action'      => 'espresso_recalculate_line_items',
-                        'TXN_ID'      => $this->_transaction->ID(),
-                        'redirect_to' => 'view_transaction',
-                    ],
-                    TXN_ADMIN_URL
-                ),
-                esc_html__(' Recalculate Taxes and Total', 'event_espresso'),
-                'button button--secondary',
-                'dashicons dashicons-update'
-            );
-        }
-
-        if (
-            $primary_registration instanceof EE_Registration
-            && EEH_MSG_Template::is_mt_active('receipt')
-        ) {
-            $actions['receipt'] = EEH_Template::get_button_or_link(
-                $primary_registration->receipt_url(),
-                esc_html__('View Receipt', 'event_espresso'),
-                'button button--secondary',
-                'dashicons dashicons-text-page'
-            );
-        }
-
-        if (
-            $primary_registration instanceof EE_Registration
-            && EEH_MSG_Template::is_mt_active('invoice')
-        ) {
-            $actions['invoice'] = EEH_Template::get_button_or_link(
-                $primary_registration->invoice_url(),
-                esc_html__('View Invoice', 'event_espresso'),
-                'button button--secondary',
-                'dashicons dashicons-media-spreadsheet'
-            );
-        }
-        $actions = array_filter(
-            apply_filters('FHEE__Transactions_Admin_Page__getActionButtons__actions', $actions, $transaction)
-        );
-        if ($actions) {
-            $content .= implode('', $actions);
-        }
-        return $content;
-    }
-
-
-    /**
-     * txn_details_meta_box
-     * generates HTML for the Transaction main meta box
-     *
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws RuntimeException
-     * @throws ReflectionException
-     */
-    public function txn_details_meta_box()
-    {
-        $this->_set_transaction_object();
-        $this->_template_args['TXN_ID']              = $this->_transaction->ID();
-        $this->_template_args['attendee']            =
-            $this->_transaction->primary_registration() instanceof EE_Registration
-                ? $this->_transaction->primary_registration()->attendee()
-                : null;
-        $this->_template_args['can_edit_payments']   = EE_Registry::instance()->CAP->current_user_can(
-            'ee_edit_payments',
-            'apply_payment_or_refund_from_registration_details'
-        );
-        $this->_template_args['can_delete_payments'] = EE_Registry::instance()->CAP->current_user_can(
-            'ee_delete_payments',
-            'delete_payment_from_registration_details'
-        );
-
-        // get line table
-        EEH_Autoloader::register_line_item_display_autoloaders();
-        $Line_Item_Display                       = new EE_Line_Item_Display(
-            'admin_table',
-            'EE_Admin_Table_Line_Item_Display_Strategy'
-        );
-        $this->_template_args['line_item_table'] = $Line_Item_Display->display_line_item(
-            $this->_transaction->total_line_item()
-        );
-        $this->_template_args['REG_code']        =
-            $this->_transaction->primary_registration() instanceof EE_Registration
-                ? $this->_transaction->primary_registration()->reg_code()
-                : null;
-        // process taxes
-        $taxes                         = $this->_transaction->line_items([['LIN_type' => EEM_Line_Item::type_tax]]);
-        $this->_template_args['taxes'] = ! empty($taxes) ? $taxes : false;
-
-        $this->_template_args['grand_total']     = EEH_Template::format_currency(
-            $this->_transaction->total(),
-            false,
-            false
-        );
-        $this->_template_args['grand_raw_total'] = $this->_transaction->total();
-        $this->_template_args['TXN_status']      = $this->_transaction->status_ID();
-
-        // process payment details
-        $payments = $this->_transaction->payments();
-        if (! empty($payments)) {
-            $this->_template_args['payments']              = $payments;
-            $this->_template_args['existing_reg_payments'] = $this->_get_registration_payment_IDs($payments);
-        } else {
-            $this->_template_args['payments']              = false;
-            $this->_template_args['existing_reg_payments'] = [];
-        }
-
-        $this->_template_args['edit_payment_url']   = add_query_arg(['action' => 'edit_payment'], TXN_ADMIN_URL);
-        $this->_template_args['delete_payment_url'] = add_query_arg(
-            ['action' => 'espresso_delete_payment'],
-            TXN_ADMIN_URL
-        );
-
-        if (isset($txn_details['invoice_number'])) {
-            $this->_template_args['txn_details']['invoice_number']['value'] = $this->_template_args['REG_code'];
-            $this->_template_args['txn_details']['invoice_number']['label'] = esc_html__(
-                'Invoice Number',
-                'event_espresso'
-            );
-        }
-
-        $this->_template_args['txn_details']['registration_session']['value'] =
-            $this->_transaction->primary_registration() instanceof EE_Registration
-                ? $this->_transaction->primary_registration()->session_ID()
-                : null;
-        $this->_template_args['txn_details']['registration_session']['label'] = esc_html__(
-            'Registration Session',
-            'event_espresso'
-        );
-
-        $this->_template_args['txn_details']['ip_address']['value'] = $this->_session['ip_address'] ?? '';
-        $this->_template_args['txn_details']['ip_address']['label'] = esc_html__(
-            'Transaction placed from IP',
-            'event_espresso'
-        );
-
-        $this->_template_args['txn_details']['user_agent']['value'] = $this->_session['user_agent'] ?? '';
-        $this->_template_args['txn_details']['user_agent']['label'] = esc_html__(
-            'Registrant User Agent',
-            'event_espresso'
-        );
-
-        $reg_steps = '<div class="ee-txn-reg-step-status-steps ee-layout-row">';
-        foreach ($this->_transaction->reg_steps() as $reg_step => $reg_step_status) {
-            if ($reg_step_status === true) {
-                $reg_steps .= '<div class="ee-status-pill ee-status-bg--success">'
-                              . sprintf(
-                                  esc_html__('%1$s : Completed', 'event_espresso'),
-                                  ucwords(str_replace('_', ' ', $reg_step))
-                              )
-                              . '</div>';
-            } elseif ($reg_step_status !== false && is_numeric($reg_step_status)) {
-                $reg_steps .= '<div class="ee-status-pill ee-status-bg--attention">'
-                              . sprintf(
-                                  esc_html__('%1$s : Initiated %2$s', 'event_espresso'),
-                                  ucwords(str_replace('_', ' ', $reg_step)),
-                                  date(
-                                      get_option('date_format') . ' ' . get_option('time_format'),
-                                      $reg_step_status + (get_option('gmt_offset') * HOUR_IN_SECONDS)
-                                  )
-                              )
-                              . '</div>';
-            } else {
-                $reg_steps .= '<div class="ee-status-pill ee-status-bg--error">'
-                              . sprintf(
-                                  esc_html__('%1$s : Never Initiated', 'event_espresso'),
-                                  ucwords(str_replace('_', ' ', $reg_step))
-                              )
-                              . '</div>';
-            }
-        }
-        $reg_steps                                                 .= '</ul>';
-        $this->_template_args['txn_details']['reg_steps']['value'] = $reg_steps;
-        $this->_template_args['txn_details']['reg_steps']['label'] = esc_html__(
-            'Registration Step Progress',
-            'event_espresso'
-        );
-
-
-        $this->_get_registrations_to_apply_payment_to();
-        $this->_get_payment_methods($payments);
-        $this->_get_payment_status_array();
-        $this->_get_reg_status_selection(); // sets up the template args for the reg status array for the transaction.
-
-        $this->_template_args['transaction_form_url']    = add_query_arg(
-            [
-                'action'  => 'edit_transaction',
-                'process' => 'transaction',
-            ],
-            TXN_ADMIN_URL
-        );
-        $this->_template_args['apply_payment_form_url']  = add_query_arg(
-            [
-                'page'   => 'espresso_transactions',
-                'action' => 'espresso_apply_payment',
-            ],
-            TXN_ADMIN_URL
-        );
-        $this->_template_args['delete_payment_form_url'] = add_query_arg(
-            [
-                'page'   => 'espresso_transactions',
-                'action' => 'espresso_delete_payment',
-            ],
-            TXN_ADMIN_URL
-        );
-
-        $this->_template_args['action_buttons'] = $this->getActionButtons($this->_transaction);
-
-        // 'espresso_delete_payment_nonce'
-
-        $template_path = TXN_TEMPLATE_PATH . 'txn_admin_details_main_meta_box_txn_details.template.php';
-        echo EEH_Template::display_template($template_path, $this->_template_args, true);
-    }
-
-
-    /**
-     * _get_registration_payment_IDs
-     *    generates an array of Payment IDs and their corresponding Registration IDs
-     *
-     * @access protected
-     * @param EE_Payment[] $payments
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _get_registration_payment_IDs($payments = [])
-    {
-        $existing_reg_payments = [];
-        // get all reg payments for these payments
-        $reg_payments = EEM_Registration_Payment::instance()->get_all(
-            [
-                [
-                    'PAY_ID' => [
-                        'IN',
-                        array_keys($payments),
-                    ],
-                ],
-            ]
-        );
-        if (! empty($reg_payments)) {
-            foreach ($payments as $payment) {
-                if (! $payment instanceof EE_Payment) {
-                    continue;
-                } elseif (! isset($existing_reg_payments[ $payment->ID() ])) {
-                    $existing_reg_payments[ $payment->ID() ] = [];
-                }
-                foreach ($reg_payments as $reg_payment) {
-                    if (
-                        $reg_payment instanceof EE_Registration_Payment
-                        && $reg_payment->payment_ID() === $payment->ID()
-                    ) {
-                        $existing_reg_payments[ $payment->ID() ][] = $reg_payment->registration_ID();
-                    }
-                }
-            }
-        }
-
-        return $existing_reg_payments;
-    }
-
-
-    /**
-     * _get_registrations_to_apply_payment_to
-     *    generates HTML for displaying a series of checkboxes in the admin payment modal window
-     * which allows the admin to only apply the payment to the specific registrations
-     *
-     * @access protected
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _get_registrations_to_apply_payment_to()
-    {
-        // we want any registration with an active status (ie: not deleted or cancelled)
-        $query_params                      = [
-            [
-                'STS_ID' => [
-                    'IN',
-                    [
-                        EEM_Registration::status_id_approved,
-                        EEM_Registration::status_id_pending_payment,
-                        EEM_Registration::status_id_not_approved,
-                    ],
-                ],
-            ],
-        ];
-        $registrations_to_apply_payment_to = EEH_HTML::br() . EEH_HTML::div(
-            '',
-            'txn-admin-apply-payment-to-registrations-dv',
-            '',
-            'clear: both; margin: 1.5em 0 0; display: none;'
-        );
-        $registrations_to_apply_payment_to .= EEH_HTML::br() . EEH_HTML::div('', '', 'admin-primary-mbox-tbl-wrap');
-        $registrations_to_apply_payment_to .= EEH_HTML::table('', '', 'admin-primary-mbox-tbl striped');
-        $registrations_to_apply_payment_to .= EEH_HTML::thead(
-            EEH_HTML::tr(
-                EEH_HTML::th(esc_html__('ID', 'event_espresso')) .
-                EEH_HTML::th(esc_html__('Registrant', 'event_espresso')) .
-                EEH_HTML::th(esc_html__('Ticket', 'event_espresso')) .
-                EEH_HTML::th(esc_html__('Event', 'event_espresso')) .
-                EEH_HTML::th(esc_html__('Paid', 'event_espresso'), '', 'txn-admin-payment-paid-td jst-cntr') .
-                EEH_HTML::th(esc_html__('Owing', 'event_espresso'), '', 'txn-admin-payment-owing-td jst-cntr') .
-                EEH_HTML::th(esc_html__('Apply', 'event_espresso'), '', 'jst-cntr')
-            )
-        );
-        $registrations_to_apply_payment_to .= EEH_HTML::tbody();
-        // get registrations for TXN
-        $registrations         = $this->_transaction->registrations($query_params);
-        $existing_reg_payments = $this->_template_args['existing_reg_payments'];
-        foreach ($registrations as $registration) {
-            if ($registration instanceof EE_Registration) {
-                $attendee_name                     = $registration->attendee() instanceof EE_Attendee
-                    ? $registration->attendee()->full_name()
-                    : esc_html__('Unknown Attendee', 'event_espresso');
-                $owing                             = $registration->final_price() - $registration->paid();
-                $taxable                           = $registration->ticket()->taxable()
-                    ? ' <span class="smaller-text lt-grey-text"> ' . esc_html__('+ tax', 'event_espresso') . '</span>'
-                    : '';
-                $checked                           = empty($existing_reg_payments)
-                                                     || in_array($registration->ID(), $existing_reg_payments, true)
-                    ? ' checked'
-                    : '';
-                $disabled                          = $registration->final_price() > 0 ? '' : ' disabled';
-                $registrations_to_apply_payment_to .= EEH_HTML::tr(
-                    EEH_HTML::td($registration->ID()) .
-                    EEH_HTML::td($attendee_name) .
-                    EEH_HTML::td(
-                        $registration->ticket()->name() . ' : ' . $registration->ticket()->pretty_price() . $taxable
-                    ) .
-                    EEH_HTML::td($registration->event_name()) .
-                    EEH_HTML::td($registration->pretty_paid(), '', 'txn-admin-payment-paid-td jst-cntr') .
-                    EEH_HTML::td(
-                        EEH_Template::format_currency($owing),
-                        '',
-                        'txn-admin-payment-owing-td jst-cntr'
-                    ) .
-                    EEH_HTML::td(
-                        '<input type="checkbox" value="' . $registration->ID()
-                        . '" name="txn_admin_payment[registrations]"'
-                        . $checked . $disabled . '>',
-                        '',
-                        'jst-cntr'
-                    ),
-                    'apply-payment-registration-row-' . $registration->ID()
-                );
-            }
-        }
-        $registrations_to_apply_payment_to                         .= EEH_HTML::tbodyx();
-        $registrations_to_apply_payment_to                         .= EEH_HTML::tablex();
-        $registrations_to_apply_payment_to                         .= EEH_HTML::divx();
-        $registrations_to_apply_payment_to                         .= EEH_HTML::p(
-            esc_html__(
-                'The payment will only be applied to the registrations that have a check mark in their corresponding check box. Checkboxes for free registrations have been disabled.',
-                'event_espresso'
-            ),
-            '',
-            'clear description'
-        );
-        $registrations_to_apply_payment_to                         .= EEH_HTML::divx();
-        $this->_template_args['registrations_to_apply_payment_to'] = $registrations_to_apply_payment_to;
-    }
-
-
-    /**
-     * _get_reg_status_selection
-     *
-     * @return void
-     * @throws EE_Error
-     * @todo   this will need to be adjusted either once MER comes along OR we move default reg status to tickets
-     *         instead of events.
-     * @access protected
-     */
-    protected function _get_reg_status_selection()
-    {
-        // first get all possible statuses
-        $statuses = EEM_Registration::reg_status_array([], true);
-        // let's add a "don't change" option.
-        $status_array['NAN']                                 = esc_html__('Leave the Same', 'event_espresso');
-        $status_array                                        = array_merge($status_array, $statuses);
-        $this->_template_args['status_change_select']        = EEH_Form_Fields::select_input(
-            'txn_reg_status_change[reg_status]',
-            $status_array,
-            'NAN',
-            'id="txn-admin-payment-reg-status-inp"',
-            'txn-reg-status-change-reg-status'
-        );
-        $this->_template_args['delete_status_change_select'] = EEH_Form_Fields::select_input(
-            'delete_txn_reg_status_change[reg_status]',
-            $status_array,
-            'NAN',
-            'delete-txn-admin-payment-reg-status-inp',
-            'delete-txn-reg-status-change-reg-status'
-        );
-    }
-
-
-    /**
-     *    _get_payment_methods
-     * Gets all the payment methods available generally, or the ones that are already
-     * selected on these payments (in case their payment methods are no longer active).
-     * Has the side-effect of updating the template args' payment_methods item
-     *
-     * @access private
-     * @param EE_Payment[] to show on this page
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function _get_payment_methods($payments = [])
-    {
-        $payment_methods_of_payments = [];
-        foreach ($payments as $payment) {
-            if ($payment instanceof EE_Payment) {
-                $payment_methods_of_payments[] = $payment->ID();
-            }
-        }
-        if ($payment_methods_of_payments) {
-            $query_args = [
-                [
-                    'OR*payment_method_for_payment' => [
-                        'PMD_ID'    => ['IN', $payment_methods_of_payments],
-                        'PMD_scope' => ['LIKE', '%' . EEM_Payment_Method::scope_admin . '%'],
-                    ],
-                ],
-            ];
-        } else {
-            $query_args = [['PMD_scope' => ['LIKE', '%' . EEM_Payment_Method::scope_admin . '%']]];
-        }
-        $this->_template_args['payment_methods'] = EEM_Payment_Method::instance()->get_all($query_args);
-    }
-
-
-    /**
-     * txn_attendees_meta_box
-     *    generates HTML for the Attendees Transaction main meta box
-     *
-     * @access public
-     * @param WP_Post $post
-     * @param array   $metabox
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function txn_attendees_meta_box($post, $metabox = ['args' => []])
-    {
-
-        /** @noinspection NonSecureExtractUsageInspection */
-        extract($metabox['args']);
-        $this->_template_args['post']            = $post;
-        $this->_template_args['event_attendees'] = [];
-        // process items in cart
-        $line_items = $this->_transaction->get_many_related(
-            'Line_Item',
-            [['LIN_type' => 'line-item']]
-        );
-        if (! empty($line_items)) {
-            foreach ($line_items as $item) {
-                if ($item instanceof EE_Line_Item) {
-                    switch ($item->OBJ_type()) {
-                        case 'Event':
-                            break;
-                        case 'Ticket':
-                            $ticket = $item->ticket();
-                            // right now we're only handling tickets here.
-                            // Cause its expected that only tickets will have attendees right?
-                            if (! $ticket instanceof EE_Ticket) {
-                                break;
-                            }
-                            try {
-                                $event_name = $ticket->get_event_name();
-                            } catch (Exception $e) {
-                                EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-                                $event_name = esc_html__('Unknown Event', 'event_espresso');
-                            }
-                            $event_name   .= ' - ' . $item->name();
-                            $ticket_price = EEH_Template::format_currency($item->unit_price());
-                            // now get all of the registrations for this transaction that use this ticket
-                            $registrations = $ticket->registrations(
-                                [['TXN_ID' => $this->_transaction->ID()]]
-                            );
-                            foreach ($registrations as $registration) {
-                                if (! $registration instanceof EE_Registration) {
-                                    break;
-                                }
-                                $this->_template_args['event_attendees'][ $registration->ID() ]['STS_ID']
-                                    = $registration->status_ID();
-                                $this->_template_args['event_attendees'][ $registration->ID() ]['att_num']
-                                    = $registration->count();
-                                $this->_template_args['event_attendees'][ $registration->ID() ]['event_ticket_name']
-                                    = $event_name;
-                                $this->_template_args['event_attendees'][ $registration->ID() ]['ticket_price']
-                                    = $ticket_price;
-                                // attendee info
-                                $attendee = $registration->get_first_related('Attendee');
-                                if ($attendee instanceof EE_Attendee) {
-                                    $this->_template_args['event_attendees'][ $registration->ID() ]['att_id']
-                                        = $attendee->ID();
-                                    $this->_template_args['event_attendees'][ $registration->ID() ]['attendee']
-                                        = $attendee->full_name();
-                                    $this->_template_args['event_attendees'][ $registration->ID() ]['email']
-                                        = '<a href="mailto:' . $attendee->email() . '?subject=' . $event_name
-                                          . esc_html__(
-                                              ' Event',
-                                              'event_espresso'
-                                          )
-                                          . '">' . $attendee->email() . '</a>';
-                                    $this->_template_args['event_attendees'][ $registration->ID() ]['address']
-                                        = EEH_Address::format($attendee, 'inline', false, false);
-                                } else {
-                                    $this->_template_args['event_attendees'][ $registration->ID() ]['att_id']   = '';
-                                    $this->_template_args['event_attendees'][ $registration->ID() ]['attendee'] = '';
-                                    $this->_template_args['event_attendees'][ $registration->ID() ]['email']    = '';
-                                    $this->_template_args['event_attendees'][ $registration->ID() ]['address']  = '';
-                                }
-                            }
-                            break;
-                    }
-                }
-            }
-
-            $this->_template_args['transaction_form_url'] = add_query_arg(
-                [
-                    'action'  => 'edit_transaction',
-                    'process' => 'attendees',
-                ],
-                TXN_ADMIN_URL
-            );
-            echo EEH_Template::display_template(
-                TXN_TEMPLATE_PATH . 'txn_admin_details_main_meta_box_attendees.template.php',
-                $this->_template_args,
-                true
-            );
-        } else {
-            printf(
-                esc_html__(
-                    '%1$sFor some reason, there are no attendees registered for this transaction. Likely the registration was abandoned in process.%2$s',
-                    'event_espresso'
-                ),
-                '<p class="important-notice">',
-                '</p>'
-            );
-        }
-    }
-
-
-    /**
-     * txn_registrant_side_meta_box
-     * generates HTML for the Edit Transaction side meta box
-     *
-     * @access public
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function txn_registrant_side_meta_box()
-    {
-        $primary_att = $this->_transaction->primary_registration() instanceof EE_Registration
-            ? $this->_transaction->primary_registration()->get_first_related('Attendee')
-            : null;
-        if (! $primary_att instanceof EE_Attendee) {
-            $this->_template_args['no_attendee_message'] = esc_html__(
-                'There is no attached contact for this transaction.  The transaction either failed due to an error or was abandoned.',
-                'event_espresso'
-            );
-            $primary_att                           = EEM_Attendee::instance()->create_default_object();
-        }
-        $this->_template_args['ATT_ID']            = $primary_att->ID();
-        $this->_template_args['prime_reg_fname']   = $primary_att->fname();
-        $this->_template_args['prime_reg_lname']   = $primary_att->lname();
-        $this->_template_args['prime_reg_email']   = $primary_att->email();
-        $this->_template_args['prime_reg_phone']   = $primary_att->phone();
-        $this->_template_args['edit_attendee_url'] = EE_Admin_Page::add_query_args_and_nonce(
-            [
-                'action' => 'edit_attendee',
-                'post'   => $primary_att->ID(),
-            ],
-            REG_ADMIN_URL
-        );
-        // get formatted address for registrant
-        $formatted_address = EEH_Address::format($primary_att);
-        $formatted_address = $formatted_address !== '<div class="espresso-address-dv"><div></div></div>'
-            ? $formatted_address
-            : '';
-        $this->_template_args['formatted_address'] = $formatted_address;
-        echo EEH_Template::display_template(
-            TXN_TEMPLATE_PATH . 'txn_admin_details_side_meta_box_registrant.template.php',
-            $this->_template_args,
-            true
-        );
-    }
-
-
-    /**
-     * txn_billing_info_side_meta_box
-     *    generates HTML for the Edit Transaction side meta box
-     *
-     * @access public
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function txn_billing_info_side_meta_box()
-    {
-
-        $this->_template_args['billing_form']     = $this->_transaction->billing_info();
-        $this->_template_args['billing_form_url'] = add_query_arg(
-            ['action' => 'edit_transaction', 'process' => 'billing'],
-            TXN_ADMIN_URL
-        );
-
-        $template_path = TXN_TEMPLATE_PATH . 'txn_admin_details_side_meta_box_billing_info.template.php';
-        echo EEH_Template::display_template($template_path, $this->_template_args, true);
-    }
-
-
-    /**
-     * apply_payments_or_refunds
-     *    registers a payment or refund made towards a transaction
-     *
-     * @access public
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function apply_payments_or_refunds()
-    {
-        $valid_data         = $this->_validate_payment_request_data();
-        $has_access         = EE_Registry::instance()->CAP->current_user_can(
-            'ee_edit_payments',
-            'apply_payment_or_refund_from_registration_details'
-        );
-        $TXD_ID = $this->request->getRequestParam('txn_admin_payment[TXN_ID]', 0, 'int');
-        $amount = 0;
-        if (! empty($valid_data) && $has_access) {
-            $PAY_ID = $valid_data['PAY_ID'];
-            // save  the new payment
-            $payment = $this->_create_payment_from_request_data($valid_data);
-            $amount = $payment->amount();
-            // get the TXN for this payment
-            $transaction = $payment->transaction();
-            // verify transaction
-            if ($transaction instanceof EE_Transaction) {
-                // calculate_total_payments_and_update_status
-                $this->_process_transaction_payments($transaction);
-                $REG_IDs = $this->_get_REG_IDs_to_apply_payment_to($payment);
-                $this->_remove_existing_registration_payments($payment, $PAY_ID);
-                // apply payment to registrations (if applicable)
-                if (! empty($REG_IDs)) {
-                    $this->_update_registration_payments($transaction, $payment, $REG_IDs);
-                    $this->_maybe_send_notifications();
-                    // now process status changes for the same registrations
-                    $this->_process_registration_status_change($transaction, $REG_IDs);
-                }
-                $this->_maybe_send_notifications($payment);
-                // prepare to render page
-                do_action(
-                    'AHEE__Transactions_Admin_Page__apply_payments_or_refund__after_recording',
-                    $transaction,
-                    $payment
-                );
-            } else {
-                EE_Error::add_error(
-                    esc_html__(
-                        'A valid Transaction for this payment could not be retrieved.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        } elseif ($has_access) {
-            EE_Error::add_error(
-                esc_html__(
-                    'The payment form data could not be processed. Please try again.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        } else {
-            EE_Error::add_error(
-                esc_html__(
-                    'You do not have access to apply payments or refunds to a registration.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        $query_args = [
-            'page' => 'espresso_transactions',
-             'action' => 'view_transaction',
-             'TXN_ID' => $TXD_ID
-        ];
-
-        $this->_redirect_after_action(
-            ! EE_Error::has_error(),
-            $amount > 0
-                ? esc_html__('payment', 'event_espresso')
-                : esc_html__('refund', 'event_espresso'),
-            esc_html__('processed', 'event_espresso'),
-            $query_args
-        );
-    }
-
-
-    /**
-     * _validate_payment_request_data
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _validate_payment_request_data()
-    {
-        if (! $this->request->requestParamIsSet('txn_admin_payment')) {
-            return [];
-        }
-        $payment_form = $this->_generate_payment_form_section();
-        try {
-            if ($payment_form->was_submitted()) {
-                $payment_form->receive_form_submission();
-                if (! $payment_form->is_valid()) {
-                    $submission_error_messages = [];
-                    foreach ($payment_form->get_validation_errors_accumulated() as $validation_error) {
-                        if ($validation_error instanceof EE_Validation_Error) {
-                            $form_input = $validation_error->get_form_section();
-                            $submission_error_messages[] = sprintf(
-                                _x('%s : %s', 'Form Section Name : Form Validation Error', 'event_espresso'),
-                                $form_input instanceof EE_Form_Input_Base ? $form_input->html_label_text() : '',
-                                $validation_error->getMessage()
-                            );
-                        }
-                    }
-                    EE_Error::add_error(
-                        implode('<br />', $submission_error_messages),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                    return [];
-                }
-            }
-        } catch (EE_Error $e) {
-            EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-            return [];
-        }
-
-        return $payment_form->valid_data();
-    }
-
-
-    /**
-     * _generate_payment_form_section
-     *
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     */
-    protected function _generate_payment_form_section()
-    {
-        return new EE_Form_Section_Proper(
-            [
-                'name'        => 'txn_admin_payment',
-                'subsections' => [
-                    'PAY_ID'          => new EE_Text_Input(
-                        [
-                            'default'               => 0,
-                            'required'              => false,
-                            'html_label_text'       => esc_html__('Payment ID', 'event_espresso'),
-                            'validation_strategies' => [new EE_Int_Normalization()],
-                        ]
-                    ),
-                    'TXN_ID'          => new EE_Text_Input(
-                        [
-                            'default'               => 0,
-                            'required'              => true,
-                            'html_label_text'       => esc_html__('Transaction ID', 'event_espresso'),
-                            'validation_strategies' => [new EE_Int_Normalization()],
-                        ]
-                    ),
-                    'type'            => new EE_Text_Input(
-                        [
-                            'default'               => 1,
-                            'required'              => true,
-                            'html_label_text'       => esc_html__('Payment or Refund', 'event_espresso'),
-                            'validation_strategies' => [new EE_Int_Normalization()],
-                        ]
-                    ),
-                    'amount'          => new EE_Text_Input(
-                        [
-                            'default'               => 0,
-                            'required'              => true,
-                            'html_label_text'       => esc_html__('Payment amount', 'event_espresso'),
-                            'validation_strategies' => [new EE_Float_Normalization()],
-                        ]
-                    ),
-                    'status'          => new EE_Text_Input(
-                        [
-                            'default'         => EEM_Payment::status_id_approved,
-                            'required'        => true,
-                            'html_label_text' => esc_html__('Payment status', 'event_espresso'),
-                        ]
-                    ),
-                    'PMD_ID'          => new EE_Text_Input(
-                        [
-                            'default'               => 2,
-                            'required'              => true,
-                            'html_label_text'       => esc_html__('Payment Method', 'event_espresso'),
-                            'validation_strategies' => [new EE_Int_Normalization()],
-                        ]
-                    ),
-                    'date'            => new EE_Text_Input(
-                        [
-                            'default'         => time(),
-                            'required'        => true,
-                            'html_label_text' => esc_html__('Payment date', 'event_espresso'),
-                        ]
-                    ),
-                    'txn_id_chq_nmbr' => new EE_Text_Input(
-                        [
-                            'default'               => '',
-                            'required'              => false,
-                            'html_label_text'       => esc_html__('Transaction or Cheque Number', 'event_espresso'),
-                            'validation_strategies' => [
-                                new EE_Max_Length_Validation_Strategy(
-                                    esc_html__('Input too long', 'event_espresso'),
-                                    100
-                                ),
-                            ],
-                        ]
-                    ),
-                    'po_number'       => new EE_Text_Input(
-                        [
-                            'default'               => '',
-                            'required'              => false,
-                            'html_label_text'       => esc_html__('Purchase Order Number', 'event_espresso'),
-                            'validation_strategies' => [
-                                new EE_Max_Length_Validation_Strategy(
-                                    esc_html__('Input too long', 'event_espresso'),
-                                    100
-                                ),
-                            ],
-                        ]
-                    ),
-                    'accounting'      => new EE_Text_Input(
-                        [
-                            'default'               => '',
-                            'required'              => false,
-                            'html_label_text'       => esc_html__('Extra Field for Accounting', 'event_espresso'),
-                            'validation_strategies' => [
-                                new EE_Max_Length_Validation_Strategy(
-                                    esc_html__('Input too long', 'event_espresso'),
-                                    100
-                                ),
-                            ],
-                        ]
-                    ),
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * _create_payment_from_request_data
-     *
-     * @param array $valid_data
-     * @return EE_Payment
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _create_payment_from_request_data($valid_data)
-    {
-        $PAY_ID = $valid_data['PAY_ID'];
-        // get payment amount
-        $amount = $valid_data['amount'] ? abs($valid_data['amount']) : 0;
-        // payments have a type value of 1 and refunds have a type value of -1
-        // so multiplying amount by type will give a positive value for payments, and negative values for refunds
-        $amount = $valid_data['type'] < 0 ? $amount * -1 : $amount;
-        // for some reason the date string coming in has extra spaces between the date and time.  This fixes that.
-        $date    = $valid_data['date']
-            ? preg_replace('/\s+/', ' ', $valid_data['date'])
-            : date('Y-m-d g:i a', current_time('timestamp'));
-        $payment = EE_Payment::new_instance(
-            [
-                'TXN_ID'              => $valid_data['TXN_ID'],
-                'STS_ID'              => $valid_data['status'],
-                'PAY_timestamp'       => $date,
-                'PAY_source'          => EEM_Payment_Method::scope_admin,
-                'PMD_ID'              => $valid_data['PMD_ID'],
-                'PAY_amount'          => $amount,
-                'PAY_txn_id_chq_nmbr' => $valid_data['txn_id_chq_nmbr'],
-                'PAY_po_number'       => $valid_data['po_number'],
-                'PAY_extra_accntng'   => $valid_data['accounting'],
-                'PAY_details'         => $valid_data,
-                'PAY_ID'              => $PAY_ID,
-            ],
-            '',
-            ['Y-m-d', 'g:i a']
-        );
-
-        if (! $payment->save()) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__('Payment %1$d has not been successfully saved to the database.', 'event_espresso'),
-                    $payment->ID()
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-
-        return $payment;
-    }
-
-
-    /**
-     * _process_transaction_payments
-     *
-     * @param EE_Transaction $transaction
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _process_transaction_payments(EE_Transaction $transaction)
-    {
-        /** @type EE_Transaction_Payments $transaction_payments */
-        $transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
-        // update the transaction with this payment
-        if ($transaction_payments->calculate_total_payments_and_update_status($transaction)) {
-            EE_Error::add_success(
-                esc_html__(
-                    'The payment has been processed successfully.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        } else {
-            EE_Error::add_error(
-                esc_html__(
-                    'The payment was processed successfully but the amount paid for the transaction was not updated.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-    }
-
-
-    /**
-     * _get_REG_IDs_to_apply_payment_to
-     * returns a list of registration IDs that the payment will apply to
-     *
-     * @param EE_Payment $payment
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _get_REG_IDs_to_apply_payment_to(EE_Payment $payment)
-    {
-        // grab array of IDs for specific registrations to apply changes to
-        $apply_to_all = $this->request->getRequestParam(
-            'txn_admin_payment[apply_to_all_registrations]',
-            false,
-            DataType::BOOL
-        );
-        $REG_IDs = ! $apply_to_all
-            ? $this->request->getRequestParam(
-                'txn_admin_payment[registrations]',
-                [],
-                DataType::INT,
-                true
-            )
-            : [];
-        // nothing specified ? then get all reg IDs
-        if ($apply_to_all || empty($REG_IDs)) {
-            $registrations = $payment->transaction()->registrations();
-            $REG_IDs       = ! empty($registrations)
-                ? array_keys($registrations)
-                : $this->_get_existing_reg_payment_REG_IDs($payment);
-        }
-        // ensure that REG_IDs are integers and NOT strings
-        return array_map('absint', $REG_IDs);
-    }
-
-
-    /**
-     * @return array
-     */
-    public function existing_reg_payment_REG_IDs()
-    {
-        return $this->_existing_reg_payment_REG_IDs;
-    }
-
-
-    /**
-     * @param array $existing_reg_payment_REG_IDs
-     */
-    public function set_existing_reg_payment_REG_IDs($existing_reg_payment_REG_IDs = null)
-    {
-        $this->_existing_reg_payment_REG_IDs = $existing_reg_payment_REG_IDs;
-    }
-
-
-    /**
-     * _get_existing_reg_payment_REG_IDs
-     * returns a list of registration IDs that the payment is currently related to
-     * as recorded in the database
-     *
-     * @param EE_Payment $payment
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _get_existing_reg_payment_REG_IDs(EE_Payment $payment)
-    {
-        if ($this->existing_reg_payment_REG_IDs() === null) {
-            // let's get any existing reg payment records for this payment
-            $existing_reg_payment_REG_IDs = $payment->get_many_related('Registration');
-            // but we only want the REG IDs, so grab the array keys
-            $existing_reg_payment_REG_IDs = ! empty($existing_reg_payment_REG_IDs)
-                ? array_keys($existing_reg_payment_REG_IDs)
-                : [];
-            $this->set_existing_reg_payment_REG_IDs($existing_reg_payment_REG_IDs);
-        }
-
-        return $this->existing_reg_payment_REG_IDs();
-    }
-
-
-    /**
-     * _remove_existing_registration_payments
-     * this calculates the difference between existing relations
-     * to the supplied payment and the new list registration IDs,
-     * removes any related registrations that no longer apply,
-     * and then updates the registration paid fields
-     *
-     * @param EE_Payment $payment
-     * @param int        $PAY_ID
-     * @return bool;
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _remove_existing_registration_payments(EE_Payment $payment, $PAY_ID = 0)
-    {
-        // newly created payments will have nothing recorded for $PAY_ID
-        if (absint($PAY_ID) === 0) {
-            return false;
-        }
-        $existing_reg_payment_REG_IDs = $this->_get_existing_reg_payment_REG_IDs($payment);
-        if (empty($existing_reg_payment_REG_IDs)) {
-            return false;
-        }
-        /** @type EE_Transaction_Payments $transaction_payments */
-        $transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
-
-        return $transaction_payments->delete_registration_payments_and_update_registrations(
-            $payment,
-            [
-                [
-                    'PAY_ID' => $payment->ID(),
-                    'REG_ID' => ['IN', $existing_reg_payment_REG_IDs],
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * _update_registration_payments
-     * this applies the payments to the selected registrations
-     * but only if they have not already been paid for
-     *
-     * @param EE_Transaction $transaction
-     * @param EE_Payment     $payment
-     * @param array          $REG_IDs
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _update_registration_payments(
-        EE_Transaction $transaction,
-        EE_Payment $payment,
-        $REG_IDs = []
-    ) {
-        // we can pass our own custom set of registrations to EE_Payment_Processor::process_registration_payments()
-        // so let's do that using our set of REG_IDs from the form
-        $registration_query_where_params = [
-            'REG_ID' => ['IN', $REG_IDs],
-        ];
-        // but add in some conditions regarding payment,
-        // so that we don't apply payments to registrations that are free or have already been paid for
-        // but ONLY if the payment is NOT a refund ( ie: the payment amount is not negative )
-        if (! $payment->is_a_refund()) {
-            $registration_query_where_params['REG_final_price']  = ['!=', 0];
-            $registration_query_where_params['REG_final_price*'] = ['!=', 'REG_paid', true];
-        }
-        $registrations = $transaction->registrations([$registration_query_where_params]);
-        if (! empty($registrations)) {
-            /** @type EE_Payment_Processor $payment_processor */
-            $payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
-            $payment_processor->process_registration_payments($transaction, $payment, $registrations);
-        }
-    }
-
-
-    /**
-     * _process_registration_status_change
-     * This processes requested registration status changes for all the registrations
-     * on a given transaction and (optionally) sends out notifications for the changes.
-     *
-     * @param EE_Transaction $transaction
-     * @param array          $REG_IDs
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _process_registration_status_change(EE_Transaction $transaction, $REG_IDs = [], $reg_status = '')
-    {
-        // first if there is no change in status then we get out.
-        $reg_status = $reg_status ?: $this->request->getRequestParam('txn_reg_status_change[reg_status]', 'NAN');
-        if ($reg_status === 'NAN') {
-            // no error message, no change requested, just nothing to do man.
-            return false;
-        }
-        /** @type EE_Transaction_Processor $transaction_processor */
-        $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
-
-        // made it here dude?  Oh WOW.  K, let's take care of changing the statuses
-        return $transaction_processor->manually_update_registration_statuses(
-            $transaction,
-            $reg_status,
-            [['REG_ID' => ['IN', $REG_IDs]]]
-        );
-    }
-
-
-    /**
-     * _build_payment_json_response
-     *
-     * @access public
-     * @param EE_Payment  $payment
-     * @param array       $REG_IDs
-     * @param bool | null $delete_txn_reg_status_change
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _build_payment_json_response(
-        EE_Payment $payment,
-        $REG_IDs = [],
-        $delete_txn_reg_status_change = null
-    ) {
-        // was the payment deleted ?
-        if (is_bool($delete_txn_reg_status_change)) {
-            return [
-                'PAY_ID'                       => $payment->ID(),
-                'amount'                       => $payment->amount(),
-                'total_paid'                   => $payment->transaction()->paid(),
-                'txn_status'                   => $payment->transaction()->status_ID(),
-                'pay_status'                   => $payment->STS_ID(),
-                'registrations'                => $this->_registration_payment_data_array($REG_IDs),
-                'delete_txn_reg_status_change' => $delete_txn_reg_status_change,
-            ];
-        }
-
-        $this->_get_payment_status_array();
-        return [
-            'amount'           => $payment->amount(),
-            'total_paid'       => $payment->transaction()->paid(),
-            'txn_status'       => $payment->transaction()->status_ID(),
-            'pay_status'       => $payment->STS_ID(),
-            'PAY_ID'           => $payment->ID(),
-            'STS_ID'           => $payment->STS_ID(),
-            'status'           => self::$_pay_status[ $payment->STS_ID() ],
-            'date'             => $payment->timestamp('Y-m-d', 'h:i a'),
-            'method'           => strtoupper($payment->source()),
-            'PM_ID'            => $payment->payment_method() ? $payment->payment_method()->ID() : 1,
-            'gateway'          => $payment->payment_method()
-                ? $payment->payment_method()->admin_name()
-                : esc_html__('Unknown', 'event_espresso'),
-            'gateway_response' => $payment->gateway_response(),
-            'txn_id_chq_nmbr'  => $payment->txn_id_chq_nmbr(),
-            'po_number'        => $payment->po_number(),
-            'extra_accntng'    => $payment->extra_accntng(),
-            'registrations'    => $this->_registration_payment_data_array($REG_IDs),
-        ];
-    }
-
-
-    /**
-     * delete_payment
-     *    delete a payment or refund made towards a transaction
-     *
-     * @access public
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function delete_payment()
-    {
-        $TXD_ID = $this->request->getRequestParam('delete_txn_admin_payment[TXN_ID]', 0, 'int');
-        // $json_response_data = ['return_data' => false];
-        $PAY_ID = $this->request->getRequestParam('delete_txn_admin_payment[PAY_ID]', 0, 'int');
-        $amount = 0;
-        $can_delete         = EE_Registry::instance()->CAP->current_user_can(
-            'ee_delete_payments',
-            'delete_payment_from_registration_details'
-        );
-        if ($PAY_ID && $can_delete) {
-            $delete_txn_reg_status_change = $this->request->getRequestParam('delete_txn_reg_status_change[reg_status]');
-            $payment = EEM_Payment::instance()->get_one_by_ID($PAY_ID);
-            if ($payment instanceof EE_Payment) {
-                $amount = $payment->amount();
-                $REG_IDs = $this->_get_existing_reg_payment_REG_IDs($payment);
-                /** @type EE_Transaction_Payments $transaction_payments */
-                $transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
-                if ($transaction_payments->delete_payment_and_update_transaction($payment)) {
-                    if ($delete_txn_reg_status_change) {
-                        $this->_maybe_send_notifications();
-                        $this->_process_registration_status_change(
-                            $payment->transaction(),
-                            $REG_IDs,
-                            $delete_txn_reg_status_change
-                        );
-                    }
-                }
-            } else {
-                EE_Error::add_error(
-                    esc_html__('Valid Payment data could not be retrieved from the database.', 'event_espresso'),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        } elseif ($can_delete) {
-            EE_Error::add_error(
-                esc_html__(
-                    'A valid Payment ID was not received, therefore payment form data could not be loaded.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        } else {
-            EE_Error::add_error(
-                esc_html__(
-                    'You do not have access to delete a payment.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        $query_args = [
-            'page'   => 'espresso_transactions',
-            'action' => 'view_transaction',
-            'TXN_ID' => $TXD_ID
-        ];
-        $this->_redirect_after_action(
-            ! EE_Error::has_error(),
-            $amount > 0
-                ? esc_html__('payment', 'event_espresso')
-                : esc_html__('refund', 'event_espresso'),
-            esc_html__('deleted', 'event_espresso'),
-            $query_args
-        );
-    }
-
-
-    /**
-     * _registration_payment_data_array
-     * adds info for 'owing' and 'paid' for each registration to the json response
-     *
-     * @access protected
-     * @param array $REG_IDs
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _registration_payment_data_array($REG_IDs)
-    {
-        $registration_payment_data = [];
-        // if non empty reg_ids lets get an array of registrations and update the values for the apply_payment/refund rows.
-        if (! empty($REG_IDs)) {
-            $registrations = EEM_Registration::instance()->get_all([['REG_ID' => ['IN', $REG_IDs]]]);
-            foreach ($registrations as $registration) {
-                if ($registration instanceof EE_Registration) {
-                    $registration_payment_data[ $registration->ID() ] = [
-                        'paid'  => $registration->pretty_paid(),
-                        'owing' => EEH_Template::format_currency($registration->final_price() - $registration->paid()),
-                    ];
-                }
-            }
-        }
-
-        return $registration_payment_data;
-    }
-
-
-    /**
-     * _maybe_send_notifications
-     * determines whether or not the admin has indicated that notifications should be sent.
-     * If so, will toggle a filter switch for delivering registration notices.
-     * If passed an EE_Payment object, then it will trigger payment notifications instead.
-     *
-     * @access protected
-     * @param EE_Payment | null $payment
-     */
-    protected function _maybe_send_notifications($payment = null)
-    {
-        switch ($payment instanceof EE_Payment) {
-            // payment notifications
-            case true:
-                if ($this->request->getRequestParam('txn_payments[send_notifications]', false, 'bool')) {
-                    $this->_process_payment_notification($payment);
-                }
-                break;
-            // registration notifications
-            case false:
-                if ($this->request->getRequestParam('txn_reg_status_change[send_notifications]', false, 'bool')) {
-                    add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true');
-                }
-                break;
-        }
-    }
-
-
-    /**
-     * _send_payment_reminder
-     *    generates HTML for the View Transaction Details Admin page
-     *
-     * @access protected
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _send_payment_reminder()
-    {
-        $TXN_ID = $this->request->getRequestParam('TXN_ID', 0, 'int');
-        $transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
-        $redirect_to = $this->request->getRequestParam('redirect_to');
-        $query_args  = $redirect_to ? ['action' => $redirect_to, 'TXN_ID' => $TXN_ID,] : [];
-        do_action(
-            'AHEE__Transactions_Admin_Page___send_payment_reminder__process_admin_payment_reminder',
-            $transaction
-        );
-        $this->_redirect_after_action(
-            false,
-            esc_html__('payment reminder', 'event_espresso'),
-            esc_html__('sent', 'event_espresso'),
-            $query_args,
-            true
-        );
-    }
-
-
-    /**
-     *  get_transactions
-     *    get transactions for given parameters (used by list table)
-     *
-     * @param int     $per_page how many transactions displayed per page
-     * @param boolean $count   return the count or objects
-     * @param string  $view
-     * @return EE_Transaction[]|int int = count || array of transaction objects
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_transactions($per_page, $count = false, $view = '')
-    {
-        $start_date = wp_strip_all_tags(
-            $this->request->getRequestParam('txn-filter-start-date', date('m/d/Y', strtotime('-10 year')))
-        );
-        $end_date = wp_strip_all_tags(
-            $this->request->getRequestParam('txn-filter-end-date', date('m/d/Y'))
-        );
-
-        // make sure our timestamps start and end right at the boundaries for each day
-        $start_date = date('Y-m-d', strtotime($start_date)) . ' 00:00:00';
-        $end_date   = date('Y-m-d', strtotime($end_date)) . ' 23:59:59';
-
-
-        // convert to timestamps
-        $start_date = strtotime($start_date);
-        $end_date   = strtotime($end_date);
-
-        // makes sure start date is the lowest value and vice versa
-        $start_date = min($start_date, $end_date);
-        $end_date   = max($start_date, $end_date);
-
-        // convert to correct format for query
-        $start_date = EEM_Transaction::instance()->convert_datetime_for_query(
-            'TXN_timestamp',
-            date('Y-m-d H:i:s', $start_date),
-            'Y-m-d H:i:s'
-        );
-        $end_date   = EEM_Transaction::instance()->convert_datetime_for_query(
-            'TXN_timestamp',
-            date('Y-m-d H:i:s', $end_date),
-            'Y-m-d H:i:s'
-        );
-
-
-        // set orderby
-        $orderby = $this->request->getRequestParam('orderby');
-
-        switch ($orderby) {
-            case 'TXN_ID':
-                break;
-            case 'ATT_fname':
-                $orderby = 'Registration.Attendee.ATT_fname';
-                break;
-            case 'event_name':
-                $orderby = 'Registration.Event.EVT_name';
-                break;
-            default: // 'TXN_timestamp'
-                $orderby = 'TXN_timestamp';
-        }
-
-        $sort         = $this->request->getRequestParam('order', 'DESC');
-        $current_page = $this->request->getRequestParam('paged', 1, 'int');
-
-        $per_page = absint($per_page) ? $per_page : 10;
-        $per_page = $this->request->getRequestParam('perpage', $per_page, 'int');
-
-        $offset = ($current_page - 1) * $per_page;
-        $limit  = [$offset, $per_page];
-
-        $_where = [
-            'TXN_timestamp'          => ['BETWEEN', [$start_date, $end_date]],
-            'Registration.REG_count' => 1,
-        ];
-
-        $EVT_ID = $this->request->getRequestParam('EVT_ID', 0, 'int');
-        if ($EVT_ID) {
-            $_where['Registration.EVT_ID'] = $EVT_ID;
-        }
-
-        $search_term = $this->request->getRequestParam('s');
-        if ($search_term) {
-            $search_term = '%' . $search_term . '%';
-            $_where['OR']  = [
-                'Registration.Event.EVT_name'         => ['LIKE', $search_term],
-                'Registration.Event.EVT_desc'         => ['LIKE', $search_term],
-                'Registration.Event.EVT_short_desc'   => ['LIKE', $search_term],
-                'Registration.Attendee.ATT_full_name' => ['LIKE', $search_term],
-                'Registration.Attendee.ATT_fname'     => ['LIKE', $search_term],
-                'Registration.Attendee.ATT_lname'     => ['LIKE', $search_term],
-                'Registration.Attendee.ATT_short_bio' => ['LIKE', $search_term],
-                'Registration.Attendee.ATT_email'     => ['LIKE', $search_term],
-                'Registration.Attendee.ATT_address'   => ['LIKE', $search_term],
-                'Registration.Attendee.ATT_address2'  => ['LIKE', $search_term],
-                'Registration.Attendee.ATT_city'      => ['LIKE', $search_term],
-                'Registration.REG_final_price'        => ['LIKE', $search_term],
-                'Registration.REG_code'               => ['LIKE', $search_term],
-                'Registration.REG_count'              => ['LIKE', $search_term],
-                'Registration.REG_group_size'         => ['LIKE', $search_term],
-                'Registration.Ticket.TKT_name'        => ['LIKE', $search_term],
-                'Registration.Ticket.TKT_description' => ['LIKE', $search_term],
-                'Payment.PAY_source'                  => ['LIKE', $search_term],
-                'Payment.Payment_Method.PMD_name'     => ['LIKE', $search_term],
-                'TXN_session_data'                    => ['LIKE', $search_term],
-                'Payment.PAY_txn_id_chq_nmbr'         => ['LIKE', $search_term],
-            ];
-        }
-
-        $status = $this->request->getRequestParam('status');
-        // failed transactions
-        $failed     = (! empty($status) && $status === 'failed' && ! $count) || ($count && $view === 'failed');
-        $abandoned  = (! empty($status) && $status === 'abandoned' && ! $count) || ($count && $view === 'abandoned');
-        $incomplete = (! empty($status) && $status === 'incomplete' && ! $count) || ($count && $view === 'incomplete');
-
-        if ($failed) {
-            $_where['STS_ID'] = EEM_Transaction::failed_status_code;
-        } elseif ($abandoned) {
-            $_where['STS_ID'] = EEM_Transaction::abandoned_status_code;
-        } elseif ($incomplete) {
-            $_where['STS_ID'] = EEM_Transaction::incomplete_status_code;
-        } else {
-            $_where['STS_ID']  = ['!=', EEM_Transaction::failed_status_code];
-            $_where['STS_ID*'] = ['!=', EEM_Transaction::abandoned_status_code];
-        }
-
-        $query_params = apply_filters(
-            'FHEE__Transactions_Admin_Page___get_transactions_query_params',
-            [
-                $_where,
-                'order_by'                 => [$orderby => $sort],
-                'limit'                    => $limit,
-                'default_where_conditions' => EEM_Base::default_where_conditions_this_only,
-            ],
-            $this->request->requestParams(),
-            $view,
-            $count
-        );
-
-        return $count
-            ? EEM_Transaction::instance()->count([$query_params[0]], 'TXN_ID', true)
-            : EEM_Transaction::instance()->get_all($query_params);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @since 4.9.79.p
-     */
-    public function recalculateLineItems()
-    {
-        $TXN_ID = $this->request->getRequestParam('TXN_ID', 0, 'int');
-        /** @var EE_Transaction $transaction */
-        $transaction     = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
-        $success         = $transaction->recalculateLineItems();
-        $redirect_to = $this->request->getRequestParam('redirect_to');
-        $query_args = $redirect_to ? ['action' => $redirect_to, 'TXN_ID' => $TXN_ID,] : [];
-        $this->_redirect_after_action(
-            $success,
-            esc_html__('Transaction taxes and totals', 'event_espresso'),
-            esc_html__('recalculated', 'event_espresso'),
-            $query_args,
-            true
-        );
-    }
+	/**
+	 * @var EE_Transaction
+	 */
+	private $_transaction;
+
+	/**
+	 * @var EE_Session
+	 */
+	private $_session;
+
+	/**
+	 * @var array $_txn_status
+	 */
+	private static $_txn_status;
+
+	/**
+	 * @var array $_pay_status
+	 */
+	private static $_pay_status;
+
+	/**
+	 * @var array $_existing_reg_payment_REG_IDs
+	 */
+	protected $_existing_reg_payment_REG_IDs;
+
+
+	/**
+	 *    _init_page_props
+	 *
+	 * @return void
+	 */
+	protected function _init_page_props()
+	{
+		$this->page_slug        = TXN_PG_SLUG;
+		$this->page_label       = esc_html__('Transactions', 'event_espresso');
+		$this->_admin_base_url  = TXN_ADMIN_URL;
+		$this->_admin_base_path = TXN_ADMIN;
+	}
+
+
+	/**
+	 *    _ajax_hooks
+	 *
+	 * @return void
+	 */
+	protected function _ajax_hooks()
+	{
+		// add_action('wp_ajax_espresso_apply_payment', [$this, 'apply_payments_or_refunds']);
+		// add_action('wp_ajax_espresso_apply_refund', [$this, 'apply_payments_or_refunds']);
+		// add_action('wp_ajax_espresso_delete_payment', [$this, 'delete_payment']);
+	}
+
+
+	/**
+	 *    _define_page_props
+	 *
+	 * @return void
+	 */
+	protected function _define_page_props()
+	{
+		$this->_admin_page_title = $this->page_label;
+		$this->_labels           = [
+			'buttons' => [
+				'add'    => esc_html__('Add New Transaction', 'event_espresso'),
+				'edit'   => esc_html__('Edit Transaction', 'event_espresso'),
+				'delete' => esc_html__('Delete Transaction', 'event_espresso'),
+			],
+		];
+	}
+
+
+	/**
+	 *        grab url requests and route them
+	 *
+	 * @access private
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function _set_page_routes()
+	{
+
+		$this->_set_transaction_status_array();
+		$TXN_ID = $this->request->getRequestParam('TXN_ID', 0, 'int');
+
+		$this->_page_routes = [
+
+			'default' => [
+				'func'       => '_transactions_overview_list_table',
+				'capability' => 'ee_read_transactions',
+			],
+
+			'view_transaction' => [
+				'func'       => '_transaction_details',
+				'capability' => 'ee_read_transaction',
+				'obj_id'     => $TXN_ID,
+			],
+
+			'send_payment_reminder' => [
+				'func'       => '_send_payment_reminder',
+				'noheader'   => true,
+				'capability' => 'ee_send_message',
+			],
+
+			'espresso_apply_payment' => [
+				'func'       => 'apply_payments_or_refunds',
+				'noheader'   => true,
+				'capability' => 'ee_edit_payments',
+			],
+
+			'espresso_apply_refund' => [
+				'func'       => 'apply_payments_or_refunds',
+				'noheader'   => true,
+				'capability' => 'ee_edit_payments',
+			],
+
+			'espresso_delete_payment' => [
+				'func'       => [$this, 'delete_payment'],
+				'noheader'   => true,
+				'capability' => 'ee_delete_payments',
+			],
+
+			'espresso_recalculate_line_items' => [
+				'func'       => 'recalculateLineItems',
+				'noheader'   => true,
+				'capability' => 'ee_edit_payments',
+			],
+
+		];
+	}
+
+
+	protected function _set_page_config()
+	{
+		$TXN_ID = $this->request->getRequestParam('TXN_ID', 0, 'int');
+		$this->_page_config = [
+			'default'          => [
+				'nav'           => [
+					'label' => esc_html__('Overview', 'event_espresso'),
+					'icon' => 'dashicons-list-view',
+					'order' => 10,
+				],
+				'list_table'    => 'EE_Admin_Transactions_List_Table',
+				'help_tabs'     => [
+					'transactions_overview_help_tab'                       => [
+						'title'    => esc_html__('Transactions Overview', 'event_espresso'),
+						'filename' => 'transactions_overview',
+					],
+					'transactions_overview_table_column_headings_help_tab' => [
+						'title'    => esc_html__('Transactions Table Column Headings', 'event_espresso'),
+						'filename' => 'transactions_overview_table_column_headings',
+					],
+					'transactions_overview_views_filters_help_tab'         => [
+						'title'    => esc_html__('Transaction Views & Filters & Search', 'event_espresso'),
+						'filename' => 'transactions_overview_views_filters_search',
+					],
+				],
+				'require_nonce' => false,
+			],
+			'view_transaction' => [
+				'nav'       => [
+					'label'      => esc_html__('View Transaction', 'event_espresso'),
+					'icon' => 'dashicons-cart',
+					'order'      => 5,
+					'url'        => $TXN_ID
+						? add_query_arg(['TXN_ID' => $TXN_ID], $this->_current_page_view_url)
+						: $this->_admin_base_url,
+					'persistent' => false,
+				],
+				'help_tabs' => [
+					'transactions_view_transaction_help_tab'                                              => [
+						'title'    => esc_html__('View Transaction', 'event_espresso'),
+						'filename' => 'transactions_view_transaction',
+					],
+					'transactions_view_transaction_transaction_details_table_help_tab'                    => [
+						'title'    => esc_html__('Transaction Details Table', 'event_espresso'),
+						'filename' => 'transactions_view_transaction_transaction_details_table',
+					],
+					'transactions_view_transaction_attendees_registered_help_tab'                         => [
+						'title'    => esc_html__('Attendees Registered', 'event_espresso'),
+						'filename' => 'transactions_view_transaction_attendees_registered',
+					],
+					'transactions_view_transaction_views_primary_registrant_billing_information_help_tab' => [
+						'title'    => esc_html__('Primary Registrant & Billing Information', 'event_espresso'),
+						'filename' => 'transactions_view_transaction_primary_registrant_billing_information',
+					],
+				],
+				'qtips'     => ['Transaction_Details_Tips'],
+				'metaboxes' => ['_transaction_details_metaboxes'],
+
+				'require_nonce' => false,
+			],
+		];
+	}
+
+
+	/**
+	 * The below methods aren't used by this class currently
+	 */
+	protected function _add_screen_options()
+	{
+		// noop
+	}
+
+
+	protected function _add_feature_pointers()
+	{
+		// noop
+	}
+
+
+	public function admin_init()
+	{
+		$EVT_ID = $this->request->getRequestParam('EVT_ID', 0, 'int');
+		$event_name = $this->request->getRequestParam('event_name');
+		$redirect_from = $this->request->getRequestParam('redirect_from', '', 'url');
+		// IF a registration was JUST added via the admin...
+		if ($EVT_ID && $event_name && $redirect_from) {
+			// then set a cookie so that we can block any attempts to use
+			// the back button as a way to enter another registration.
+			setcookie('ee_registration_added', $EVT_ID, time() + WEEK_IN_SECONDS, '/');
+			// and update the global
+			$_COOKIE['ee_registration_added'] = $EVT_ID;
+		}
+		EE_Registry::$i18n_js_strings['invalid_server_response'] = esc_html__(
+			'An error occurred! Your request may have been processed, but a valid response from the server was not received. Please refresh the page and try again.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['error_occurred']          = esc_html__(
+			'An error occurred! Please refresh the page and try again.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['txn_status_array']        = self::$_txn_status;
+		EE_Registry::$i18n_js_strings['pay_status_array']        = self::$_pay_status;
+		EE_Registry::$i18n_js_strings['payments_total']          = esc_html__('Payments Total', 'event_espresso');
+		EE_Registry::$i18n_js_strings['transaction_overpaid']    = esc_html__(
+			'This transaction has been overpaid ! Payments Total',
+			'event_espresso'
+		);
+	}
+
+
+	public function admin_notices()
+	{
+		// noop
+	}
+
+
+	public function admin_footer_scripts()
+	{
+		// noop
+	}
+
+
+	/**
+	 * _set_transaction_status_array
+	 * sets list of transaction statuses
+	 *
+	 * @access private
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _set_transaction_status_array()
+	{
+		self::$_txn_status = EEM_Transaction::instance()->status_array(true);
+	}
+
+
+	/**
+	 * get_transaction_status_array
+	 * return the transaction status array for wp_list_table
+	 *
+	 * @access public
+	 * @return array
+	 */
+	public function get_transaction_status_array()
+	{
+		return self::$_txn_status;
+	}
+
+
+	/**
+	 *    get list of payment statuses
+	 *
+	 * @access private
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _get_payment_status_array()
+	{
+		self::$_pay_status                      = EEM_Payment::instance()->status_array(true);
+		$this->_template_args['payment_status'] = self::$_pay_status;
+	}
+
+
+	/**
+	 *    _add_screen_options_default
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _add_screen_options_default()
+	{
+		$this->_per_page_screen_option();
+	}
+
+
+	/**
+	 * load_scripts_styles
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function load_scripts_styles()
+	{
+		// enqueue style
+		wp_register_style(
+			'espresso_txn',
+			TXN_ASSETS_URL . 'espresso_transactions_admin.css',
+			[],
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('espresso_txn');
+		// scripts
+		wp_register_script(
+			'espresso_txn',
+			TXN_ASSETS_URL . 'espresso_transactions_admin.js',
+			[
+				'ee_admin_js',
+				'ee-datepicker',
+				'jquery-ui-datepicker',
+				'jquery-ui-draggable',
+				'ee-dialog',
+				'ee-accounting',
+				'ee-serialize-full-array',
+			],
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_enqueue_script('espresso_txn');
+	}
+
+
+	/**
+	 *    load_scripts_styles_view_transaction
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function load_scripts_styles_view_transaction()
+	{
+		// styles
+		wp_enqueue_style('espresso-ui-theme');
+	}
+
+
+	/**
+	 *    load_scripts_styles_default
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function load_scripts_styles_default()
+	{
+		// styles
+		wp_enqueue_style('espresso-ui-theme');
+	}
+
+
+	/**
+	 *    _set_list_table_views_default
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_list_table_views_default()
+	{
+		$this->_views = [
+			'all'        => [
+				'slug'  => 'all',
+				'label' => esc_html__('View All Transactions', 'event_espresso'),
+				'count' => 0,
+			],
+			'abandoned'  => [
+				'slug'  => 'abandoned',
+				'label' => esc_html__('Abandoned Transactions', 'event_espresso'),
+				'count' => 0,
+			],
+			'incomplete' => [
+				'slug'  => 'incomplete',
+				'label' => esc_html__('Incomplete Transactions', 'event_espresso'),
+				'count' => 0,
+			],
+		];
+		if (
+			/**
+			 * Filters whether a link to the "Failed Transactions" list table
+			 * appears on the Transactions Admin Page list table.
+			 * List display can be turned back on via the following:
+			 * add_filter(
+			 *     'FHEE__Transactions_Admin_Page___set_list_table_views_default__display_failed_txns_list',
+			 *     '__return_true'
+			 * );
+			 *
+			 * @param boolean                 $display_failed_txns_list
+			 * @param Transactions_Admin_Page $this
+			 * @since 4.9.70.p
+			 */
+			apply_filters(
+				'FHEE__Transactions_Admin_Page___set_list_table_views_default__display_failed_txns_list',
+				false,
+				$this
+			)
+		) {
+			$this->_views['failed'] = [
+				'slug'  => 'failed',
+				'label' => esc_html__('Failed Transactions', 'event_espresso'),
+				'count' => 0,
+			];
+		}
+	}
+
+
+	/**
+	 * _set_transaction_object
+	 * This sets the _transaction property for the transaction details screen
+	 *
+	 * @access private
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function _set_transaction_object()
+	{
+		if ($this->_transaction instanceof EE_Transaction) {
+			return;
+		} //get out we've already set the object
+
+		$TXN_ID = $this->request->getRequestParam('TXN_ID', 0, 'int');
+
+		// get transaction object
+		$this->_transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
+		$this->_session     = $this->_transaction instanceof EE_Transaction
+			? $this->_transaction->session_data()
+			: null;
+		if ($this->_transaction instanceof EE_Transaction) {
+			$this->_transaction->verify_abandoned_transaction_status();
+		}
+
+		if (! $this->_transaction instanceof EE_Transaction) {
+			$error_msg = sprintf(
+				esc_html__(
+					'An error occurred and the details for the transaction with the ID # %d could not be retrieved.',
+					'event_espresso'
+				),
+				$TXN_ID
+			);
+			EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+	}
+
+
+	/**
+	 *    _transaction_legend_items
+	 *
+	 * @access protected
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _transaction_legend_items()
+	{
+		EE_Registry::instance()->load_helper('MSG_Template');
+		$items = [];
+
+		if (
+			EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_global_messages',
+				'view_filtered_messages'
+			)
+		) {
+			$related_for_icon = EEH_MSG_Template::get_message_action_icon('see_notifications_for');
+			if (
+				is_array($related_for_icon)
+				&& isset($related_for_icon['css_class'], $related_for_icon['label'])
+			) {
+				$items['view_related_messages'] = [
+					'class' => $related_for_icon['css_class'],
+					'desc'  => $related_for_icon['label'],
+				];
+			}
+		}
+
+		$items = apply_filters(
+			'FHEE__Transactions_Admin_Page___transaction_legend_items__items',
+			array_merge(
+				$items,
+				[
+					'view_details'          => [
+						'class' => 'dashicons dashicons-cart',
+						'desc'  => esc_html__('View Transaction Details', 'event_espresso'),
+					],
+					'view_invoice'          => [
+						'class' => 'dashicons dashicons-media-spreadsheet',
+						'desc'  => esc_html__('View Transaction Invoice', 'event_espresso'),
+					],
+					'view_receipt'          => [
+						'class' => 'dashicons dashicons-text-page',
+						'desc'  => esc_html__('View Transaction Receipt', 'event_espresso'),
+					],
+					'view_registration'     => [
+						'class' => 'dashicons dashicons-clipboard',
+						'desc'  => esc_html__('View Registration Details', 'event_espresso'),
+					],
+					'payment_overview_link' => [
+						'class' => 'dashicons dashicons-money',
+						'desc'  => esc_html__('Make Payment on Frontend', 'event_espresso'),
+					],
+				]
+			)
+		);
+
+		if (
+			EEH_MSG_Template::is_mt_active('payment_reminder')
+			&& EE_Registry::instance()->CAP->current_user_can(
+				'ee_send_message',
+				'espresso_transactions_send_payment_reminder'
+			)
+		) {
+			$items['send_payment_reminder'] = [
+				'class' => 'dashicons dashicons-email-alt',
+				'desc'  => esc_html__('Send Payment Reminder', 'event_espresso'),
+			];
+		} else {
+			$items['blank*'] = [
+				'class' => '',
+				'desc'  => '',
+			];
+		}
+		$more_items = apply_filters(
+			'FHEE__Transactions_Admin_Page___transaction_legend_items__more_items',
+			[
+				'overpaid'   => [
+					'class' => 'ee-status-legend ee-status-bg--' . EEM_Transaction::overpaid_status_code,
+					'desc'  => EEH_Template::pretty_status(
+						EEM_Transaction::overpaid_status_code,
+						false,
+						'sentence'
+					),
+				],
+				'complete'   => [
+					'class' => 'ee-status-legend ee-status-bg--' . EEM_Transaction::complete_status_code,
+					'desc'  => EEH_Template::pretty_status(
+						EEM_Transaction::complete_status_code,
+						false,
+						'sentence'
+					),
+				],
+				'incomplete' => [
+					'class' => 'ee-status-legend ee-status-bg--' . EEM_Transaction::incomplete_status_code,
+					'desc'  => EEH_Template::pretty_status(
+						EEM_Transaction::incomplete_status_code,
+						false,
+						'sentence'
+					),
+				],
+				'abandoned'  => [
+					'class' => 'ee-status-legend ee-status-bg--' . EEM_Transaction::abandoned_status_code,
+					'desc'  => EEH_Template::pretty_status(
+						EEM_Transaction::abandoned_status_code,
+						false,
+						'sentence'
+					),
+				],
+				'failed'     => [
+					'class' => 'ee-status-legend ee-status-bg--' . EEM_Transaction::failed_status_code,
+					'desc'  => EEH_Template::pretty_status(
+						EEM_Transaction::failed_status_code,
+						false,
+						'sentence'
+					),
+				],
+			]
+		);
+
+		return array_merge($items, $more_items);
+	}
+
+
+	/**
+	 *    _transactions_overview_list_table
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _transactions_overview_list_table()
+	{
+		$this->_admin_page_title = esc_html__('Transactions', 'event_espresso');
+
+		$EVT_ID = $this->request->getRequestParam('EVT_ID', 0, 'int');
+		$event = EEM_Event::instance()->get_one_by_ID($EVT_ID);
+		$this->_template_args['admin_page_header'] = $event instanceof EE_Event
+			? sprintf(
+				esc_html__('%sViewing Transactions for the Event: %s%s', 'event_espresso'),
+				'<h3>',
+				'<a href="'
+				. EE_Admin_Page::add_query_args_and_nonce(
+					['action' => 'edit', 'post' => $event->ID()],
+					EVENTS_ADMIN_URL
+				)
+				. '" title="'
+				. esc_attr__('Click to Edit event', 'event_espresso')
+				. '">' . $event->name() . '</a>',
+				'</h3>'
+			)
+			: '';
+		$this->_template_args['after_list_table']  = $this->_display_legend($this->_transaction_legend_items());
+		$this->display_admin_list_table_page_with_no_sidebar();
+	}
+
+
+	/**
+	 *    _transaction_details
+	 * generates HTML for the View Transaction Details Admin page
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws RuntimeException
+	 * @throws ReflectionException
+	 */
+	protected function _transaction_details()
+	{
+		do_action('AHEE__Transactions_Admin_Page__transaction_details__start', $this->_transaction);
+
+		$this->_set_transaction_status_array();
+
+		$this->_template_args                      = [];
+		$this->_template_args['transactions_page'] = $this->_wp_page_slug;
+
+		$this->_set_transaction_object();
+
+		if (! $this->_transaction instanceof EE_Transaction) {
+			return;
+		}
+
+		$this->_template_args['txn_nmbr']['value'] = $this->_transaction->ID();
+		$this->_template_args['txn_nmbr']['label'] = esc_html__('Transaction Number', 'event_espresso');
+
+		$this->_template_args['txn_datetime']['value'] = $this->_transaction->get_i18n_datetime('TXN_timestamp');
+		$this->_template_args['txn_datetime']['label'] = esc_html__('Date', 'event_espresso');
+
+		$this->_template_args['txn_status']['value'] = self::$_txn_status[ $this->_transaction->status_ID() ];
+		$this->_template_args['txn_status']['label'] = esc_html__('Transaction Status', 'event_espresso');
+		$this->_template_args['txn_status']['class'] = $this->_transaction->status_ID();
+
+		$txn_total  = $this->_transaction->total();
+		$total_paid = $this->_transaction->paid();
+		$amount_due = $txn_total - $total_paid;
+
+		$this->_template_args['grand_total'] = $txn_total;
+		$this->_template_args['total_paid']  = $total_paid;
+
+		$this->_template_args['amount_due'] = EEH_Template::format_currency($amount_due, false, false);
+
+		$this->_template_args['amount_due_class'] = '';
+
+		if ($txn_total === (float) 0) {
+			// free event
+			$this->_template_args['amount_due'] = false;
+		} elseif ($amount_due < (float) 0) {
+			// overpaid
+			$this->_template_args['amount_due_class'] = 'txn-overview-no-payment-spn';
+		} elseif ($amount_due > (float) 0) {
+			// monies owing
+			$this->_template_args['amount_due_class'] = 'txn-overview-part-payment-spn ee-txn-amount-owing';
+		} elseif ($total_paid === (float) 0) {
+			// no payments made yet
+			$this->_template_args['amount_due_class'] = 'txn-overview-no-payment-spn';
+		}
+
+		$payment_method = $this->_transaction->payment_method();
+
+		$this->_template_args['method_of_payment_name'] = $payment_method instanceof EE_Payment_Method
+			? $payment_method->admin_name()
+			: esc_html__('Unknown', 'event_espresso');
+
+		$this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign;
+		// link back to overview
+		$this->_template_args['txn_overview_url'] = $this->request->getServerParam(
+			'HTTP_REFERER',
+			TXN_ADMIN_URL
+		);
+
+
+		// next link
+		$next_txn                                 = $this->_transaction->next(
+			null,
+			[['STS_ID' => ['!=', EEM_Transaction::failed_status_code]]],
+			'TXN_ID'
+		);
+		$this->_template_args['next_transaction'] = $next_txn
+			? $this->_next_link(
+				EE_Admin_Page::add_query_args_and_nonce(
+					['action' => 'view_transaction', 'TXN_ID' => $next_txn['TXN_ID']],
+					TXN_ADMIN_URL
+				),
+				'dashicons dashicons-arrow-right ee-icon-size-22'
+			)
+			: '';
+		// previous link
+		$previous_txn                                 = $this->_transaction->previous(
+			null,
+			[['STS_ID' => ['!=', EEM_Transaction::failed_status_code]]],
+			'TXN_ID'
+		);
+		$this->_template_args['previous_transaction'] = $previous_txn
+			? $this->_previous_link(
+				EE_Admin_Page::add_query_args_and_nonce(
+					['action' => 'view_transaction', 'TXN_ID' => $previous_txn['TXN_ID']],
+					TXN_ADMIN_URL
+				),
+				'dashicons dashicons-arrow-left ee-icon-size-22'
+			)
+			: '';
+
+		$EVT_ID        = $this->request->getRequestParam('EVT_ID', 0, 'int');
+		$event_name    = $this->request->getRequestParam('event_name');
+		$redirect_from = $this->request->getRequestParam('redirect_from', '', 'url');
+
+		// were we just redirected here after adding a new registration ???
+		if ($EVT_ID && $event_name && $redirect_from) {
+			if (
+				EE_Registry::instance()->CAP->current_user_can(
+					'ee_edit_registrations',
+					'espresso_registrations_new_registration',
+					$EVT_ID
+				)
+			) {
+				$this->_admin_page_title .= '<a id="add-new-registration" class="add-new-h2 button--primary" href="';
+				$this->_admin_page_title .= EE_Admin_Page::add_query_args_and_nonce(
+					[
+						'page'     => 'espresso_registrations',
+						'action'   => 'new_registration',
+						'return'   => 'default',
+						'TXN_ID'   => $this->_transaction->ID(),
+						'event_id' => $EVT_ID,
+					],
+					REG_ADMIN_URL
+				);
+				$this->_admin_page_title .= '">';
+
+				$this->_admin_page_title .= sprintf(
+					esc_html__('Add Another New Registration to Event: "%1$s" ?', 'event_espresso'),
+					htmlentities(urldecode($event_name), ENT_QUOTES, 'UTF-8')
+				);
+				$this->_admin_page_title .= '</a>';
+			}
+			EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
+		}
+		// grab messages at the last second
+		$this->_template_args['notices'] = EE_Error::get_notices();
+		// path to template
+		$template_path                             = TXN_TEMPLATE_PATH . 'txn_admin_details_header.template.php';
+		$this->_template_args['admin_page_header'] = EEH_Template::display_template(
+			$template_path,
+			$this->_template_args,
+			true
+		);
+
+		// the details template wrapper
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 *        _transaction_details_metaboxes
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws RuntimeException
+	 * @throws ReflectionException
+	 */
+	protected function _transaction_details_metaboxes()
+	{
+
+		$this->_set_transaction_object();
+
+		if (! $this->_transaction instanceof EE_Transaction) {
+			return;
+		}
+		$this->addMetaBox(
+			'edit-txn-details-mbox',
+			'<span>' . esc_html__('Transaction Details', 'event_espresso')
+			. '&nbsp;<span class="dashicons dashicons-cart" ></span></span>',
+			[$this, 'txn_details_meta_box'],
+			$this->_wp_page_slug
+		);
+		$this->addMetaBox(
+			'edit-txn-attendees-mbox',
+			'<span>' . esc_html__('Attendees Registered in this Transaction', 'event_espresso')
+			. '&nbsp;<span class="dashicons dashicons-groups" ></span></span>',
+			[$this, 'txn_attendees_meta_box'],
+			$this->_wp_page_slug,
+			'normal',
+			'high',
+			['TXN_ID' => $this->_transaction->ID()]
+		);
+		$this->addMetaBox(
+			'edit-txn-registrant-mbox',
+			esc_html__('Primary Contact', 'event_espresso'),
+			[$this, 'txn_registrant_side_meta_box'],
+			$this->_wp_page_slug,
+			'side'
+		);
+		$this->addMetaBox(
+			'edit-txn-billing-info-mbox',
+			esc_html__('Billing Information', 'event_espresso'),
+			[$this, 'txn_billing_info_side_meta_box'],
+			$this->_wp_page_slug,
+			'side'
+		);
+	}
+
+
+	/**
+	 * Callback for transaction actions metabox.
+	 *
+	 * @param EE_Transaction|null $transaction
+	 * @return string
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	public function getActionButtons(EE_Transaction $transaction = null)
+	{
+		$content = '';
+		$actions = [];
+		if (! $transaction instanceof EE_Transaction) {
+			return $content;
+		}
+		/** @var EE_Registration $primary_registration */
+		$primary_registration = $transaction->primary_registration();
+		$attendee             = $primary_registration instanceof EE_Registration
+			? $primary_registration->attendee()
+			: null;
+
+		if (
+			$attendee instanceof EE_Attendee
+			&& EE_Registry::instance()->CAP->current_user_can(
+				'ee_send_message',
+				'espresso_transactions_send_payment_reminder'
+			)
+		) {
+			$actions['payment_reminder'] =
+				EEH_MSG_Template::is_mt_active('payment_reminder')
+				&& $this->_transaction->status_ID() !== EEM_Transaction::complete_status_code
+				&& $this->_transaction->status_ID() !== EEM_Transaction::overpaid_status_code
+					? EEH_Template::get_button_or_link(
+						EE_Admin_Page::add_query_args_and_nonce(
+							[
+							'action'      => 'send_payment_reminder',
+							'TXN_ID'      => $this->_transaction->ID(),
+							'redirect_to' => 'view_transaction',
+							],
+							TXN_ADMIN_URL
+						),
+						esc_html__(' Send Payment Reminder', 'event_espresso'),
+						'button button--secondary',
+						'dashicons dashicons-email-alt'
+					)
+					: '';
+		}
+
+		if (
+			EE_Registry::instance()->CAP->current_user_can(
+				'ee_edit_payments',
+				'espresso_transactions_recalculate_line_items'
+			)
+		) {
+			$actions['recalculate_line_items'] = EEH_Template::get_button_or_link(
+				EE_Admin_Page::add_query_args_and_nonce(
+					[
+						'action'      => 'espresso_recalculate_line_items',
+						'TXN_ID'      => $this->_transaction->ID(),
+						'redirect_to' => 'view_transaction',
+					],
+					TXN_ADMIN_URL
+				),
+				esc_html__(' Recalculate Taxes and Total', 'event_espresso'),
+				'button button--secondary',
+				'dashicons dashicons-update'
+			);
+		}
+
+		if (
+			$primary_registration instanceof EE_Registration
+			&& EEH_MSG_Template::is_mt_active('receipt')
+		) {
+			$actions['receipt'] = EEH_Template::get_button_or_link(
+				$primary_registration->receipt_url(),
+				esc_html__('View Receipt', 'event_espresso'),
+				'button button--secondary',
+				'dashicons dashicons-text-page'
+			);
+		}
+
+		if (
+			$primary_registration instanceof EE_Registration
+			&& EEH_MSG_Template::is_mt_active('invoice')
+		) {
+			$actions['invoice'] = EEH_Template::get_button_or_link(
+				$primary_registration->invoice_url(),
+				esc_html__('View Invoice', 'event_espresso'),
+				'button button--secondary',
+				'dashicons dashicons-media-spreadsheet'
+			);
+		}
+		$actions = array_filter(
+			apply_filters('FHEE__Transactions_Admin_Page__getActionButtons__actions', $actions, $transaction)
+		);
+		if ($actions) {
+			$content .= implode('', $actions);
+		}
+		return $content;
+	}
+
+
+	/**
+	 * txn_details_meta_box
+	 * generates HTML for the Transaction main meta box
+	 *
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws RuntimeException
+	 * @throws ReflectionException
+	 */
+	public function txn_details_meta_box()
+	{
+		$this->_set_transaction_object();
+		$this->_template_args['TXN_ID']              = $this->_transaction->ID();
+		$this->_template_args['attendee']            =
+			$this->_transaction->primary_registration() instanceof EE_Registration
+				? $this->_transaction->primary_registration()->attendee()
+				: null;
+		$this->_template_args['can_edit_payments']   = EE_Registry::instance()->CAP->current_user_can(
+			'ee_edit_payments',
+			'apply_payment_or_refund_from_registration_details'
+		);
+		$this->_template_args['can_delete_payments'] = EE_Registry::instance()->CAP->current_user_can(
+			'ee_delete_payments',
+			'delete_payment_from_registration_details'
+		);
+
+		// get line table
+		EEH_Autoloader::register_line_item_display_autoloaders();
+		$Line_Item_Display                       = new EE_Line_Item_Display(
+			'admin_table',
+			'EE_Admin_Table_Line_Item_Display_Strategy'
+		);
+		$this->_template_args['line_item_table'] = $Line_Item_Display->display_line_item(
+			$this->_transaction->total_line_item()
+		);
+		$this->_template_args['REG_code']        =
+			$this->_transaction->primary_registration() instanceof EE_Registration
+				? $this->_transaction->primary_registration()->reg_code()
+				: null;
+		// process taxes
+		$taxes                         = $this->_transaction->line_items([['LIN_type' => EEM_Line_Item::type_tax]]);
+		$this->_template_args['taxes'] = ! empty($taxes) ? $taxes : false;
+
+		$this->_template_args['grand_total']     = EEH_Template::format_currency(
+			$this->_transaction->total(),
+			false,
+			false
+		);
+		$this->_template_args['grand_raw_total'] = $this->_transaction->total();
+		$this->_template_args['TXN_status']      = $this->_transaction->status_ID();
+
+		// process payment details
+		$payments = $this->_transaction->payments();
+		if (! empty($payments)) {
+			$this->_template_args['payments']              = $payments;
+			$this->_template_args['existing_reg_payments'] = $this->_get_registration_payment_IDs($payments);
+		} else {
+			$this->_template_args['payments']              = false;
+			$this->_template_args['existing_reg_payments'] = [];
+		}
+
+		$this->_template_args['edit_payment_url']   = add_query_arg(['action' => 'edit_payment'], TXN_ADMIN_URL);
+		$this->_template_args['delete_payment_url'] = add_query_arg(
+			['action' => 'espresso_delete_payment'],
+			TXN_ADMIN_URL
+		);
+
+		if (isset($txn_details['invoice_number'])) {
+			$this->_template_args['txn_details']['invoice_number']['value'] = $this->_template_args['REG_code'];
+			$this->_template_args['txn_details']['invoice_number']['label'] = esc_html__(
+				'Invoice Number',
+				'event_espresso'
+			);
+		}
+
+		$this->_template_args['txn_details']['registration_session']['value'] =
+			$this->_transaction->primary_registration() instanceof EE_Registration
+				? $this->_transaction->primary_registration()->session_ID()
+				: null;
+		$this->_template_args['txn_details']['registration_session']['label'] = esc_html__(
+			'Registration Session',
+			'event_espresso'
+		);
+
+		$this->_template_args['txn_details']['ip_address']['value'] = $this->_session['ip_address'] ?? '';
+		$this->_template_args['txn_details']['ip_address']['label'] = esc_html__(
+			'Transaction placed from IP',
+			'event_espresso'
+		);
+
+		$this->_template_args['txn_details']['user_agent']['value'] = $this->_session['user_agent'] ?? '';
+		$this->_template_args['txn_details']['user_agent']['label'] = esc_html__(
+			'Registrant User Agent',
+			'event_espresso'
+		);
+
+		$reg_steps = '<div class="ee-txn-reg-step-status-steps ee-layout-row">';
+		foreach ($this->_transaction->reg_steps() as $reg_step => $reg_step_status) {
+			if ($reg_step_status === true) {
+				$reg_steps .= '<div class="ee-status-pill ee-status-bg--success">'
+							  . sprintf(
+								  esc_html__('%1$s : Completed', 'event_espresso'),
+								  ucwords(str_replace('_', ' ', $reg_step))
+							  )
+							  . '</div>';
+			} elseif ($reg_step_status !== false && is_numeric($reg_step_status)) {
+				$reg_steps .= '<div class="ee-status-pill ee-status-bg--attention">'
+							  . sprintf(
+								  esc_html__('%1$s : Initiated %2$s', 'event_espresso'),
+								  ucwords(str_replace('_', ' ', $reg_step)),
+								  date(
+									  get_option('date_format') . ' ' . get_option('time_format'),
+									  $reg_step_status + (get_option('gmt_offset') * HOUR_IN_SECONDS)
+								  )
+							  )
+							  . '</div>';
+			} else {
+				$reg_steps .= '<div class="ee-status-pill ee-status-bg--error">'
+							  . sprintf(
+								  esc_html__('%1$s : Never Initiated', 'event_espresso'),
+								  ucwords(str_replace('_', ' ', $reg_step))
+							  )
+							  . '</div>';
+			}
+		}
+		$reg_steps                                                 .= '</ul>';
+		$this->_template_args['txn_details']['reg_steps']['value'] = $reg_steps;
+		$this->_template_args['txn_details']['reg_steps']['label'] = esc_html__(
+			'Registration Step Progress',
+			'event_espresso'
+		);
+
+
+		$this->_get_registrations_to_apply_payment_to();
+		$this->_get_payment_methods($payments);
+		$this->_get_payment_status_array();
+		$this->_get_reg_status_selection(); // sets up the template args for the reg status array for the transaction.
+
+		$this->_template_args['transaction_form_url']    = add_query_arg(
+			[
+				'action'  => 'edit_transaction',
+				'process' => 'transaction',
+			],
+			TXN_ADMIN_URL
+		);
+		$this->_template_args['apply_payment_form_url']  = add_query_arg(
+			[
+				'page'   => 'espresso_transactions',
+				'action' => 'espresso_apply_payment',
+			],
+			TXN_ADMIN_URL
+		);
+		$this->_template_args['delete_payment_form_url'] = add_query_arg(
+			[
+				'page'   => 'espresso_transactions',
+				'action' => 'espresso_delete_payment',
+			],
+			TXN_ADMIN_URL
+		);
+
+		$this->_template_args['action_buttons'] = $this->getActionButtons($this->_transaction);
+
+		// 'espresso_delete_payment_nonce'
+
+		$template_path = TXN_TEMPLATE_PATH . 'txn_admin_details_main_meta_box_txn_details.template.php';
+		echo EEH_Template::display_template($template_path, $this->_template_args, true);
+	}
+
+
+	/**
+	 * _get_registration_payment_IDs
+	 *    generates an array of Payment IDs and their corresponding Registration IDs
+	 *
+	 * @access protected
+	 * @param EE_Payment[] $payments
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _get_registration_payment_IDs($payments = [])
+	{
+		$existing_reg_payments = [];
+		// get all reg payments for these payments
+		$reg_payments = EEM_Registration_Payment::instance()->get_all(
+			[
+				[
+					'PAY_ID' => [
+						'IN',
+						array_keys($payments),
+					],
+				],
+			]
+		);
+		if (! empty($reg_payments)) {
+			foreach ($payments as $payment) {
+				if (! $payment instanceof EE_Payment) {
+					continue;
+				} elseif (! isset($existing_reg_payments[ $payment->ID() ])) {
+					$existing_reg_payments[ $payment->ID() ] = [];
+				}
+				foreach ($reg_payments as $reg_payment) {
+					if (
+						$reg_payment instanceof EE_Registration_Payment
+						&& $reg_payment->payment_ID() === $payment->ID()
+					) {
+						$existing_reg_payments[ $payment->ID() ][] = $reg_payment->registration_ID();
+					}
+				}
+			}
+		}
+
+		return $existing_reg_payments;
+	}
+
+
+	/**
+	 * _get_registrations_to_apply_payment_to
+	 *    generates HTML for displaying a series of checkboxes in the admin payment modal window
+	 * which allows the admin to only apply the payment to the specific registrations
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _get_registrations_to_apply_payment_to()
+	{
+		// we want any registration with an active status (ie: not deleted or cancelled)
+		$query_params                      = [
+			[
+				'STS_ID' => [
+					'IN',
+					[
+						EEM_Registration::status_id_approved,
+						EEM_Registration::status_id_pending_payment,
+						EEM_Registration::status_id_not_approved,
+					],
+				],
+			],
+		];
+		$registrations_to_apply_payment_to = EEH_HTML::br() . EEH_HTML::div(
+			'',
+			'txn-admin-apply-payment-to-registrations-dv',
+			'',
+			'clear: both; margin: 1.5em 0 0; display: none;'
+		);
+		$registrations_to_apply_payment_to .= EEH_HTML::br() . EEH_HTML::div('', '', 'admin-primary-mbox-tbl-wrap');
+		$registrations_to_apply_payment_to .= EEH_HTML::table('', '', 'admin-primary-mbox-tbl striped');
+		$registrations_to_apply_payment_to .= EEH_HTML::thead(
+			EEH_HTML::tr(
+				EEH_HTML::th(esc_html__('ID', 'event_espresso')) .
+				EEH_HTML::th(esc_html__('Registrant', 'event_espresso')) .
+				EEH_HTML::th(esc_html__('Ticket', 'event_espresso')) .
+				EEH_HTML::th(esc_html__('Event', 'event_espresso')) .
+				EEH_HTML::th(esc_html__('Paid', 'event_espresso'), '', 'txn-admin-payment-paid-td jst-cntr') .
+				EEH_HTML::th(esc_html__('Owing', 'event_espresso'), '', 'txn-admin-payment-owing-td jst-cntr') .
+				EEH_HTML::th(esc_html__('Apply', 'event_espresso'), '', 'jst-cntr')
+			)
+		);
+		$registrations_to_apply_payment_to .= EEH_HTML::tbody();
+		// get registrations for TXN
+		$registrations         = $this->_transaction->registrations($query_params);
+		$existing_reg_payments = $this->_template_args['existing_reg_payments'];
+		foreach ($registrations as $registration) {
+			if ($registration instanceof EE_Registration) {
+				$attendee_name                     = $registration->attendee() instanceof EE_Attendee
+					? $registration->attendee()->full_name()
+					: esc_html__('Unknown Attendee', 'event_espresso');
+				$owing                             = $registration->final_price() - $registration->paid();
+				$taxable                           = $registration->ticket()->taxable()
+					? ' <span class="smaller-text lt-grey-text"> ' . esc_html__('+ tax', 'event_espresso') . '</span>'
+					: '';
+				$checked                           = empty($existing_reg_payments)
+													 || in_array($registration->ID(), $existing_reg_payments, true)
+					? ' checked'
+					: '';
+				$disabled                          = $registration->final_price() > 0 ? '' : ' disabled';
+				$registrations_to_apply_payment_to .= EEH_HTML::tr(
+					EEH_HTML::td($registration->ID()) .
+					EEH_HTML::td($attendee_name) .
+					EEH_HTML::td(
+						$registration->ticket()->name() . ' : ' . $registration->ticket()->pretty_price() . $taxable
+					) .
+					EEH_HTML::td($registration->event_name()) .
+					EEH_HTML::td($registration->pretty_paid(), '', 'txn-admin-payment-paid-td jst-cntr') .
+					EEH_HTML::td(
+						EEH_Template::format_currency($owing),
+						'',
+						'txn-admin-payment-owing-td jst-cntr'
+					) .
+					EEH_HTML::td(
+						'<input type="checkbox" value="' . $registration->ID()
+						. '" name="txn_admin_payment[registrations]"'
+						. $checked . $disabled . '>',
+						'',
+						'jst-cntr'
+					),
+					'apply-payment-registration-row-' . $registration->ID()
+				);
+			}
+		}
+		$registrations_to_apply_payment_to                         .= EEH_HTML::tbodyx();
+		$registrations_to_apply_payment_to                         .= EEH_HTML::tablex();
+		$registrations_to_apply_payment_to                         .= EEH_HTML::divx();
+		$registrations_to_apply_payment_to                         .= EEH_HTML::p(
+			esc_html__(
+				'The payment will only be applied to the registrations that have a check mark in their corresponding check box. Checkboxes for free registrations have been disabled.',
+				'event_espresso'
+			),
+			'',
+			'clear description'
+		);
+		$registrations_to_apply_payment_to                         .= EEH_HTML::divx();
+		$this->_template_args['registrations_to_apply_payment_to'] = $registrations_to_apply_payment_to;
+	}
+
+
+	/**
+	 * _get_reg_status_selection
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @todo   this will need to be adjusted either once MER comes along OR we move default reg status to tickets
+	 *         instead of events.
+	 * @access protected
+	 */
+	protected function _get_reg_status_selection()
+	{
+		// first get all possible statuses
+		$statuses = EEM_Registration::reg_status_array([], true);
+		// let's add a "don't change" option.
+		$status_array['NAN']                                 = esc_html__('Leave the Same', 'event_espresso');
+		$status_array                                        = array_merge($status_array, $statuses);
+		$this->_template_args['status_change_select']        = EEH_Form_Fields::select_input(
+			'txn_reg_status_change[reg_status]',
+			$status_array,
+			'NAN',
+			'id="txn-admin-payment-reg-status-inp"',
+			'txn-reg-status-change-reg-status'
+		);
+		$this->_template_args['delete_status_change_select'] = EEH_Form_Fields::select_input(
+			'delete_txn_reg_status_change[reg_status]',
+			$status_array,
+			'NAN',
+			'delete-txn-admin-payment-reg-status-inp',
+			'delete-txn-reg-status-change-reg-status'
+		);
+	}
+
+
+	/**
+	 *    _get_payment_methods
+	 * Gets all the payment methods available generally, or the ones that are already
+	 * selected on these payments (in case their payment methods are no longer active).
+	 * Has the side-effect of updating the template args' payment_methods item
+	 *
+	 * @access private
+	 * @param EE_Payment[] to show on this page
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function _get_payment_methods($payments = [])
+	{
+		$payment_methods_of_payments = [];
+		foreach ($payments as $payment) {
+			if ($payment instanceof EE_Payment) {
+				$payment_methods_of_payments[] = $payment->ID();
+			}
+		}
+		if ($payment_methods_of_payments) {
+			$query_args = [
+				[
+					'OR*payment_method_for_payment' => [
+						'PMD_ID'    => ['IN', $payment_methods_of_payments],
+						'PMD_scope' => ['LIKE', '%' . EEM_Payment_Method::scope_admin . '%'],
+					],
+				],
+			];
+		} else {
+			$query_args = [['PMD_scope' => ['LIKE', '%' . EEM_Payment_Method::scope_admin . '%']]];
+		}
+		$this->_template_args['payment_methods'] = EEM_Payment_Method::instance()->get_all($query_args);
+	}
+
+
+	/**
+	 * txn_attendees_meta_box
+	 *    generates HTML for the Attendees Transaction main meta box
+	 *
+	 * @access public
+	 * @param WP_Post $post
+	 * @param array   $metabox
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function txn_attendees_meta_box($post, $metabox = ['args' => []])
+	{
+
+		/** @noinspection NonSecureExtractUsageInspection */
+		extract($metabox['args']);
+		$this->_template_args['post']            = $post;
+		$this->_template_args['event_attendees'] = [];
+		// process items in cart
+		$line_items = $this->_transaction->get_many_related(
+			'Line_Item',
+			[['LIN_type' => 'line-item']]
+		);
+		if (! empty($line_items)) {
+			foreach ($line_items as $item) {
+				if ($item instanceof EE_Line_Item) {
+					switch ($item->OBJ_type()) {
+						case 'Event':
+							break;
+						case 'Ticket':
+							$ticket = $item->ticket();
+							// right now we're only handling tickets here.
+							// Cause its expected that only tickets will have attendees right?
+							if (! $ticket instanceof EE_Ticket) {
+								break;
+							}
+							try {
+								$event_name = $ticket->get_event_name();
+							} catch (Exception $e) {
+								EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+								$event_name = esc_html__('Unknown Event', 'event_espresso');
+							}
+							$event_name   .= ' - ' . $item->name();
+							$ticket_price = EEH_Template::format_currency($item->unit_price());
+							// now get all of the registrations for this transaction that use this ticket
+							$registrations = $ticket->registrations(
+								[['TXN_ID' => $this->_transaction->ID()]]
+							);
+							foreach ($registrations as $registration) {
+								if (! $registration instanceof EE_Registration) {
+									break;
+								}
+								$this->_template_args['event_attendees'][ $registration->ID() ]['STS_ID']
+									= $registration->status_ID();
+								$this->_template_args['event_attendees'][ $registration->ID() ]['att_num']
+									= $registration->count();
+								$this->_template_args['event_attendees'][ $registration->ID() ]['event_ticket_name']
+									= $event_name;
+								$this->_template_args['event_attendees'][ $registration->ID() ]['ticket_price']
+									= $ticket_price;
+								// attendee info
+								$attendee = $registration->get_first_related('Attendee');
+								if ($attendee instanceof EE_Attendee) {
+									$this->_template_args['event_attendees'][ $registration->ID() ]['att_id']
+										= $attendee->ID();
+									$this->_template_args['event_attendees'][ $registration->ID() ]['attendee']
+										= $attendee->full_name();
+									$this->_template_args['event_attendees'][ $registration->ID() ]['email']
+										= '<a href="mailto:' . $attendee->email() . '?subject=' . $event_name
+										  . esc_html__(
+											  ' Event',
+											  'event_espresso'
+										  )
+										  . '">' . $attendee->email() . '</a>';
+									$this->_template_args['event_attendees'][ $registration->ID() ]['address']
+										= EEH_Address::format($attendee, 'inline', false, false);
+								} else {
+									$this->_template_args['event_attendees'][ $registration->ID() ]['att_id']   = '';
+									$this->_template_args['event_attendees'][ $registration->ID() ]['attendee'] = '';
+									$this->_template_args['event_attendees'][ $registration->ID() ]['email']    = '';
+									$this->_template_args['event_attendees'][ $registration->ID() ]['address']  = '';
+								}
+							}
+							break;
+					}
+				}
+			}
+
+			$this->_template_args['transaction_form_url'] = add_query_arg(
+				[
+					'action'  => 'edit_transaction',
+					'process' => 'attendees',
+				],
+				TXN_ADMIN_URL
+			);
+			echo EEH_Template::display_template(
+				TXN_TEMPLATE_PATH . 'txn_admin_details_main_meta_box_attendees.template.php',
+				$this->_template_args,
+				true
+			);
+		} else {
+			printf(
+				esc_html__(
+					'%1$sFor some reason, there are no attendees registered for this transaction. Likely the registration was abandoned in process.%2$s',
+					'event_espresso'
+				),
+				'<p class="important-notice">',
+				'</p>'
+			);
+		}
+	}
+
+
+	/**
+	 * txn_registrant_side_meta_box
+	 * generates HTML for the Edit Transaction side meta box
+	 *
+	 * @access public
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function txn_registrant_side_meta_box()
+	{
+		$primary_att = $this->_transaction->primary_registration() instanceof EE_Registration
+			? $this->_transaction->primary_registration()->get_first_related('Attendee')
+			: null;
+		if (! $primary_att instanceof EE_Attendee) {
+			$this->_template_args['no_attendee_message'] = esc_html__(
+				'There is no attached contact for this transaction.  The transaction either failed due to an error or was abandoned.',
+				'event_espresso'
+			);
+			$primary_att                           = EEM_Attendee::instance()->create_default_object();
+		}
+		$this->_template_args['ATT_ID']            = $primary_att->ID();
+		$this->_template_args['prime_reg_fname']   = $primary_att->fname();
+		$this->_template_args['prime_reg_lname']   = $primary_att->lname();
+		$this->_template_args['prime_reg_email']   = $primary_att->email();
+		$this->_template_args['prime_reg_phone']   = $primary_att->phone();
+		$this->_template_args['edit_attendee_url'] = EE_Admin_Page::add_query_args_and_nonce(
+			[
+				'action' => 'edit_attendee',
+				'post'   => $primary_att->ID(),
+			],
+			REG_ADMIN_URL
+		);
+		// get formatted address for registrant
+		$formatted_address = EEH_Address::format($primary_att);
+		$formatted_address = $formatted_address !== '<div class="espresso-address-dv"><div></div></div>'
+			? $formatted_address
+			: '';
+		$this->_template_args['formatted_address'] = $formatted_address;
+		echo EEH_Template::display_template(
+			TXN_TEMPLATE_PATH . 'txn_admin_details_side_meta_box_registrant.template.php',
+			$this->_template_args,
+			true
+		);
+	}
+
+
+	/**
+	 * txn_billing_info_side_meta_box
+	 *    generates HTML for the Edit Transaction side meta box
+	 *
+	 * @access public
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function txn_billing_info_side_meta_box()
+	{
+
+		$this->_template_args['billing_form']     = $this->_transaction->billing_info();
+		$this->_template_args['billing_form_url'] = add_query_arg(
+			['action' => 'edit_transaction', 'process' => 'billing'],
+			TXN_ADMIN_URL
+		);
+
+		$template_path = TXN_TEMPLATE_PATH . 'txn_admin_details_side_meta_box_billing_info.template.php';
+		echo EEH_Template::display_template($template_path, $this->_template_args, true);
+	}
+
+
+	/**
+	 * apply_payments_or_refunds
+	 *    registers a payment or refund made towards a transaction
+	 *
+	 * @access public
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function apply_payments_or_refunds()
+	{
+		$valid_data         = $this->_validate_payment_request_data();
+		$has_access         = EE_Registry::instance()->CAP->current_user_can(
+			'ee_edit_payments',
+			'apply_payment_or_refund_from_registration_details'
+		);
+		$TXD_ID = $this->request->getRequestParam('txn_admin_payment[TXN_ID]', 0, 'int');
+		$amount = 0;
+		if (! empty($valid_data) && $has_access) {
+			$PAY_ID = $valid_data['PAY_ID'];
+			// save  the new payment
+			$payment = $this->_create_payment_from_request_data($valid_data);
+			$amount = $payment->amount();
+			// get the TXN for this payment
+			$transaction = $payment->transaction();
+			// verify transaction
+			if ($transaction instanceof EE_Transaction) {
+				// calculate_total_payments_and_update_status
+				$this->_process_transaction_payments($transaction);
+				$REG_IDs = $this->_get_REG_IDs_to_apply_payment_to($payment);
+				$this->_remove_existing_registration_payments($payment, $PAY_ID);
+				// apply payment to registrations (if applicable)
+				if (! empty($REG_IDs)) {
+					$this->_update_registration_payments($transaction, $payment, $REG_IDs);
+					$this->_maybe_send_notifications();
+					// now process status changes for the same registrations
+					$this->_process_registration_status_change($transaction, $REG_IDs);
+				}
+				$this->_maybe_send_notifications($payment);
+				// prepare to render page
+				do_action(
+					'AHEE__Transactions_Admin_Page__apply_payments_or_refund__after_recording',
+					$transaction,
+					$payment
+				);
+			} else {
+				EE_Error::add_error(
+					esc_html__(
+						'A valid Transaction for this payment could not be retrieved.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		} elseif ($has_access) {
+			EE_Error::add_error(
+				esc_html__(
+					'The payment form data could not be processed. Please try again.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		} else {
+			EE_Error::add_error(
+				esc_html__(
+					'You do not have access to apply payments or refunds to a registration.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		$query_args = [
+			'page' => 'espresso_transactions',
+			 'action' => 'view_transaction',
+			 'TXN_ID' => $TXD_ID
+		];
+
+		$this->_redirect_after_action(
+			! EE_Error::has_error(),
+			$amount > 0
+				? esc_html__('payment', 'event_espresso')
+				: esc_html__('refund', 'event_espresso'),
+			esc_html__('processed', 'event_espresso'),
+			$query_args
+		);
+	}
+
+
+	/**
+	 * _validate_payment_request_data
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _validate_payment_request_data()
+	{
+		if (! $this->request->requestParamIsSet('txn_admin_payment')) {
+			return [];
+		}
+		$payment_form = $this->_generate_payment_form_section();
+		try {
+			if ($payment_form->was_submitted()) {
+				$payment_form->receive_form_submission();
+				if (! $payment_form->is_valid()) {
+					$submission_error_messages = [];
+					foreach ($payment_form->get_validation_errors_accumulated() as $validation_error) {
+						if ($validation_error instanceof EE_Validation_Error) {
+							$form_input = $validation_error->get_form_section();
+							$submission_error_messages[] = sprintf(
+								_x('%s : %s', 'Form Section Name : Form Validation Error', 'event_espresso'),
+								$form_input instanceof EE_Form_Input_Base ? $form_input->html_label_text() : '',
+								$validation_error->getMessage()
+							);
+						}
+					}
+					EE_Error::add_error(
+						implode('<br />', $submission_error_messages),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+					return [];
+				}
+			}
+		} catch (EE_Error $e) {
+			EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+			return [];
+		}
+
+		return $payment_form->valid_data();
+	}
+
+
+	/**
+	 * _generate_payment_form_section
+	 *
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 */
+	protected function _generate_payment_form_section()
+	{
+		return new EE_Form_Section_Proper(
+			[
+				'name'        => 'txn_admin_payment',
+				'subsections' => [
+					'PAY_ID'          => new EE_Text_Input(
+						[
+							'default'               => 0,
+							'required'              => false,
+							'html_label_text'       => esc_html__('Payment ID', 'event_espresso'),
+							'validation_strategies' => [new EE_Int_Normalization()],
+						]
+					),
+					'TXN_ID'          => new EE_Text_Input(
+						[
+							'default'               => 0,
+							'required'              => true,
+							'html_label_text'       => esc_html__('Transaction ID', 'event_espresso'),
+							'validation_strategies' => [new EE_Int_Normalization()],
+						]
+					),
+					'type'            => new EE_Text_Input(
+						[
+							'default'               => 1,
+							'required'              => true,
+							'html_label_text'       => esc_html__('Payment or Refund', 'event_espresso'),
+							'validation_strategies' => [new EE_Int_Normalization()],
+						]
+					),
+					'amount'          => new EE_Text_Input(
+						[
+							'default'               => 0,
+							'required'              => true,
+							'html_label_text'       => esc_html__('Payment amount', 'event_espresso'),
+							'validation_strategies' => [new EE_Float_Normalization()],
+						]
+					),
+					'status'          => new EE_Text_Input(
+						[
+							'default'         => EEM_Payment::status_id_approved,
+							'required'        => true,
+							'html_label_text' => esc_html__('Payment status', 'event_espresso'),
+						]
+					),
+					'PMD_ID'          => new EE_Text_Input(
+						[
+							'default'               => 2,
+							'required'              => true,
+							'html_label_text'       => esc_html__('Payment Method', 'event_espresso'),
+							'validation_strategies' => [new EE_Int_Normalization()],
+						]
+					),
+					'date'            => new EE_Text_Input(
+						[
+							'default'         => time(),
+							'required'        => true,
+							'html_label_text' => esc_html__('Payment date', 'event_espresso'),
+						]
+					),
+					'txn_id_chq_nmbr' => new EE_Text_Input(
+						[
+							'default'               => '',
+							'required'              => false,
+							'html_label_text'       => esc_html__('Transaction or Cheque Number', 'event_espresso'),
+							'validation_strategies' => [
+								new EE_Max_Length_Validation_Strategy(
+									esc_html__('Input too long', 'event_espresso'),
+									100
+								),
+							],
+						]
+					),
+					'po_number'       => new EE_Text_Input(
+						[
+							'default'               => '',
+							'required'              => false,
+							'html_label_text'       => esc_html__('Purchase Order Number', 'event_espresso'),
+							'validation_strategies' => [
+								new EE_Max_Length_Validation_Strategy(
+									esc_html__('Input too long', 'event_espresso'),
+									100
+								),
+							],
+						]
+					),
+					'accounting'      => new EE_Text_Input(
+						[
+							'default'               => '',
+							'required'              => false,
+							'html_label_text'       => esc_html__('Extra Field for Accounting', 'event_espresso'),
+							'validation_strategies' => [
+								new EE_Max_Length_Validation_Strategy(
+									esc_html__('Input too long', 'event_espresso'),
+									100
+								),
+							],
+						]
+					),
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * _create_payment_from_request_data
+	 *
+	 * @param array $valid_data
+	 * @return EE_Payment
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _create_payment_from_request_data($valid_data)
+	{
+		$PAY_ID = $valid_data['PAY_ID'];
+		// get payment amount
+		$amount = $valid_data['amount'] ? abs($valid_data['amount']) : 0;
+		// payments have a type value of 1 and refunds have a type value of -1
+		// so multiplying amount by type will give a positive value for payments, and negative values for refunds
+		$amount = $valid_data['type'] < 0 ? $amount * -1 : $amount;
+		// for some reason the date string coming in has extra spaces between the date and time.  This fixes that.
+		$date    = $valid_data['date']
+			? preg_replace('/\s+/', ' ', $valid_data['date'])
+			: date('Y-m-d g:i a', current_time('timestamp'));
+		$payment = EE_Payment::new_instance(
+			[
+				'TXN_ID'              => $valid_data['TXN_ID'],
+				'STS_ID'              => $valid_data['status'],
+				'PAY_timestamp'       => $date,
+				'PAY_source'          => EEM_Payment_Method::scope_admin,
+				'PMD_ID'              => $valid_data['PMD_ID'],
+				'PAY_amount'          => $amount,
+				'PAY_txn_id_chq_nmbr' => $valid_data['txn_id_chq_nmbr'],
+				'PAY_po_number'       => $valid_data['po_number'],
+				'PAY_extra_accntng'   => $valid_data['accounting'],
+				'PAY_details'         => $valid_data,
+				'PAY_ID'              => $PAY_ID,
+			],
+			'',
+			['Y-m-d', 'g:i a']
+		);
+
+		if (! $payment->save()) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__('Payment %1$d has not been successfully saved to the database.', 'event_espresso'),
+					$payment->ID()
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+
+		return $payment;
+	}
+
+
+	/**
+	 * _process_transaction_payments
+	 *
+	 * @param EE_Transaction $transaction
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _process_transaction_payments(EE_Transaction $transaction)
+	{
+		/** @type EE_Transaction_Payments $transaction_payments */
+		$transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
+		// update the transaction with this payment
+		if ($transaction_payments->calculate_total_payments_and_update_status($transaction)) {
+			EE_Error::add_success(
+				esc_html__(
+					'The payment has been processed successfully.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		} else {
+			EE_Error::add_error(
+				esc_html__(
+					'The payment was processed successfully but the amount paid for the transaction was not updated.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+	}
+
+
+	/**
+	 * _get_REG_IDs_to_apply_payment_to
+	 * returns a list of registration IDs that the payment will apply to
+	 *
+	 * @param EE_Payment $payment
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _get_REG_IDs_to_apply_payment_to(EE_Payment $payment)
+	{
+		// grab array of IDs for specific registrations to apply changes to
+		$apply_to_all = $this->request->getRequestParam(
+			'txn_admin_payment[apply_to_all_registrations]',
+			false,
+			DataType::BOOL
+		);
+		$REG_IDs = ! $apply_to_all
+			? $this->request->getRequestParam(
+				'txn_admin_payment[registrations]',
+				[],
+				DataType::INT,
+				true
+			)
+			: [];
+		// nothing specified ? then get all reg IDs
+		if ($apply_to_all || empty($REG_IDs)) {
+			$registrations = $payment->transaction()->registrations();
+			$REG_IDs       = ! empty($registrations)
+				? array_keys($registrations)
+				: $this->_get_existing_reg_payment_REG_IDs($payment);
+		}
+		// ensure that REG_IDs are integers and NOT strings
+		return array_map('absint', $REG_IDs);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function existing_reg_payment_REG_IDs()
+	{
+		return $this->_existing_reg_payment_REG_IDs;
+	}
+
+
+	/**
+	 * @param array $existing_reg_payment_REG_IDs
+	 */
+	public function set_existing_reg_payment_REG_IDs($existing_reg_payment_REG_IDs = null)
+	{
+		$this->_existing_reg_payment_REG_IDs = $existing_reg_payment_REG_IDs;
+	}
+
+
+	/**
+	 * _get_existing_reg_payment_REG_IDs
+	 * returns a list of registration IDs that the payment is currently related to
+	 * as recorded in the database
+	 *
+	 * @param EE_Payment $payment
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _get_existing_reg_payment_REG_IDs(EE_Payment $payment)
+	{
+		if ($this->existing_reg_payment_REG_IDs() === null) {
+			// let's get any existing reg payment records for this payment
+			$existing_reg_payment_REG_IDs = $payment->get_many_related('Registration');
+			// but we only want the REG IDs, so grab the array keys
+			$existing_reg_payment_REG_IDs = ! empty($existing_reg_payment_REG_IDs)
+				? array_keys($existing_reg_payment_REG_IDs)
+				: [];
+			$this->set_existing_reg_payment_REG_IDs($existing_reg_payment_REG_IDs);
+		}
+
+		return $this->existing_reg_payment_REG_IDs();
+	}
+
+
+	/**
+	 * _remove_existing_registration_payments
+	 * this calculates the difference between existing relations
+	 * to the supplied payment and the new list registration IDs,
+	 * removes any related registrations that no longer apply,
+	 * and then updates the registration paid fields
+	 *
+	 * @param EE_Payment $payment
+	 * @param int        $PAY_ID
+	 * @return bool;
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _remove_existing_registration_payments(EE_Payment $payment, $PAY_ID = 0)
+	{
+		// newly created payments will have nothing recorded for $PAY_ID
+		if (absint($PAY_ID) === 0) {
+			return false;
+		}
+		$existing_reg_payment_REG_IDs = $this->_get_existing_reg_payment_REG_IDs($payment);
+		if (empty($existing_reg_payment_REG_IDs)) {
+			return false;
+		}
+		/** @type EE_Transaction_Payments $transaction_payments */
+		$transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
+
+		return $transaction_payments->delete_registration_payments_and_update_registrations(
+			$payment,
+			[
+				[
+					'PAY_ID' => $payment->ID(),
+					'REG_ID' => ['IN', $existing_reg_payment_REG_IDs],
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * _update_registration_payments
+	 * this applies the payments to the selected registrations
+	 * but only if they have not already been paid for
+	 *
+	 * @param EE_Transaction $transaction
+	 * @param EE_Payment     $payment
+	 * @param array          $REG_IDs
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _update_registration_payments(
+		EE_Transaction $transaction,
+		EE_Payment $payment,
+		$REG_IDs = []
+	) {
+		// we can pass our own custom set of registrations to EE_Payment_Processor::process_registration_payments()
+		// so let's do that using our set of REG_IDs from the form
+		$registration_query_where_params = [
+			'REG_ID' => ['IN', $REG_IDs],
+		];
+		// but add in some conditions regarding payment,
+		// so that we don't apply payments to registrations that are free or have already been paid for
+		// but ONLY if the payment is NOT a refund ( ie: the payment amount is not negative )
+		if (! $payment->is_a_refund()) {
+			$registration_query_where_params['REG_final_price']  = ['!=', 0];
+			$registration_query_where_params['REG_final_price*'] = ['!=', 'REG_paid', true];
+		}
+		$registrations = $transaction->registrations([$registration_query_where_params]);
+		if (! empty($registrations)) {
+			/** @type EE_Payment_Processor $payment_processor */
+			$payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
+			$payment_processor->process_registration_payments($transaction, $payment, $registrations);
+		}
+	}
+
+
+	/**
+	 * _process_registration_status_change
+	 * This processes requested registration status changes for all the registrations
+	 * on a given transaction and (optionally) sends out notifications for the changes.
+	 *
+	 * @param EE_Transaction $transaction
+	 * @param array          $REG_IDs
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _process_registration_status_change(EE_Transaction $transaction, $REG_IDs = [], $reg_status = '')
+	{
+		// first if there is no change in status then we get out.
+		$reg_status = $reg_status ?: $this->request->getRequestParam('txn_reg_status_change[reg_status]', 'NAN');
+		if ($reg_status === 'NAN') {
+			// no error message, no change requested, just nothing to do man.
+			return false;
+		}
+		/** @type EE_Transaction_Processor $transaction_processor */
+		$transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
+
+		// made it here dude?  Oh WOW.  K, let's take care of changing the statuses
+		return $transaction_processor->manually_update_registration_statuses(
+			$transaction,
+			$reg_status,
+			[['REG_ID' => ['IN', $REG_IDs]]]
+		);
+	}
+
+
+	/**
+	 * _build_payment_json_response
+	 *
+	 * @access public
+	 * @param EE_Payment  $payment
+	 * @param array       $REG_IDs
+	 * @param bool | null $delete_txn_reg_status_change
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _build_payment_json_response(
+		EE_Payment $payment,
+		$REG_IDs = [],
+		$delete_txn_reg_status_change = null
+	) {
+		// was the payment deleted ?
+		if (is_bool($delete_txn_reg_status_change)) {
+			return [
+				'PAY_ID'                       => $payment->ID(),
+				'amount'                       => $payment->amount(),
+				'total_paid'                   => $payment->transaction()->paid(),
+				'txn_status'                   => $payment->transaction()->status_ID(),
+				'pay_status'                   => $payment->STS_ID(),
+				'registrations'                => $this->_registration_payment_data_array($REG_IDs),
+				'delete_txn_reg_status_change' => $delete_txn_reg_status_change,
+			];
+		}
+
+		$this->_get_payment_status_array();
+		return [
+			'amount'           => $payment->amount(),
+			'total_paid'       => $payment->transaction()->paid(),
+			'txn_status'       => $payment->transaction()->status_ID(),
+			'pay_status'       => $payment->STS_ID(),
+			'PAY_ID'           => $payment->ID(),
+			'STS_ID'           => $payment->STS_ID(),
+			'status'           => self::$_pay_status[ $payment->STS_ID() ],
+			'date'             => $payment->timestamp('Y-m-d', 'h:i a'),
+			'method'           => strtoupper($payment->source()),
+			'PM_ID'            => $payment->payment_method() ? $payment->payment_method()->ID() : 1,
+			'gateway'          => $payment->payment_method()
+				? $payment->payment_method()->admin_name()
+				: esc_html__('Unknown', 'event_espresso'),
+			'gateway_response' => $payment->gateway_response(),
+			'txn_id_chq_nmbr'  => $payment->txn_id_chq_nmbr(),
+			'po_number'        => $payment->po_number(),
+			'extra_accntng'    => $payment->extra_accntng(),
+			'registrations'    => $this->_registration_payment_data_array($REG_IDs),
+		];
+	}
+
+
+	/**
+	 * delete_payment
+	 *    delete a payment or refund made towards a transaction
+	 *
+	 * @access public
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function delete_payment()
+	{
+		$TXD_ID = $this->request->getRequestParam('delete_txn_admin_payment[TXN_ID]', 0, 'int');
+		// $json_response_data = ['return_data' => false];
+		$PAY_ID = $this->request->getRequestParam('delete_txn_admin_payment[PAY_ID]', 0, 'int');
+		$amount = 0;
+		$can_delete         = EE_Registry::instance()->CAP->current_user_can(
+			'ee_delete_payments',
+			'delete_payment_from_registration_details'
+		);
+		if ($PAY_ID && $can_delete) {
+			$delete_txn_reg_status_change = $this->request->getRequestParam('delete_txn_reg_status_change[reg_status]');
+			$payment = EEM_Payment::instance()->get_one_by_ID($PAY_ID);
+			if ($payment instanceof EE_Payment) {
+				$amount = $payment->amount();
+				$REG_IDs = $this->_get_existing_reg_payment_REG_IDs($payment);
+				/** @type EE_Transaction_Payments $transaction_payments */
+				$transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
+				if ($transaction_payments->delete_payment_and_update_transaction($payment)) {
+					if ($delete_txn_reg_status_change) {
+						$this->_maybe_send_notifications();
+						$this->_process_registration_status_change(
+							$payment->transaction(),
+							$REG_IDs,
+							$delete_txn_reg_status_change
+						);
+					}
+				}
+			} else {
+				EE_Error::add_error(
+					esc_html__('Valid Payment data could not be retrieved from the database.', 'event_espresso'),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		} elseif ($can_delete) {
+			EE_Error::add_error(
+				esc_html__(
+					'A valid Payment ID was not received, therefore payment form data could not be loaded.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		} else {
+			EE_Error::add_error(
+				esc_html__(
+					'You do not have access to delete a payment.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		$query_args = [
+			'page'   => 'espresso_transactions',
+			'action' => 'view_transaction',
+			'TXN_ID' => $TXD_ID
+		];
+		$this->_redirect_after_action(
+			! EE_Error::has_error(),
+			$amount > 0
+				? esc_html__('payment', 'event_espresso')
+				: esc_html__('refund', 'event_espresso'),
+			esc_html__('deleted', 'event_espresso'),
+			$query_args
+		);
+	}
+
+
+	/**
+	 * _registration_payment_data_array
+	 * adds info for 'owing' and 'paid' for each registration to the json response
+	 *
+	 * @access protected
+	 * @param array $REG_IDs
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _registration_payment_data_array($REG_IDs)
+	{
+		$registration_payment_data = [];
+		// if non empty reg_ids lets get an array of registrations and update the values for the apply_payment/refund rows.
+		if (! empty($REG_IDs)) {
+			$registrations = EEM_Registration::instance()->get_all([['REG_ID' => ['IN', $REG_IDs]]]);
+			foreach ($registrations as $registration) {
+				if ($registration instanceof EE_Registration) {
+					$registration_payment_data[ $registration->ID() ] = [
+						'paid'  => $registration->pretty_paid(),
+						'owing' => EEH_Template::format_currency($registration->final_price() - $registration->paid()),
+					];
+				}
+			}
+		}
+
+		return $registration_payment_data;
+	}
+
+
+	/**
+	 * _maybe_send_notifications
+	 * determines whether or not the admin has indicated that notifications should be sent.
+	 * If so, will toggle a filter switch for delivering registration notices.
+	 * If passed an EE_Payment object, then it will trigger payment notifications instead.
+	 *
+	 * @access protected
+	 * @param EE_Payment | null $payment
+	 */
+	protected function _maybe_send_notifications($payment = null)
+	{
+		switch ($payment instanceof EE_Payment) {
+			// payment notifications
+			case true:
+				if ($this->request->getRequestParam('txn_payments[send_notifications]', false, 'bool')) {
+					$this->_process_payment_notification($payment);
+				}
+				break;
+			// registration notifications
+			case false:
+				if ($this->request->getRequestParam('txn_reg_status_change[send_notifications]', false, 'bool')) {
+					add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true');
+				}
+				break;
+		}
+	}
+
+
+	/**
+	 * _send_payment_reminder
+	 *    generates HTML for the View Transaction Details Admin page
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _send_payment_reminder()
+	{
+		$TXN_ID = $this->request->getRequestParam('TXN_ID', 0, 'int');
+		$transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
+		$redirect_to = $this->request->getRequestParam('redirect_to');
+		$query_args  = $redirect_to ? ['action' => $redirect_to, 'TXN_ID' => $TXN_ID,] : [];
+		do_action(
+			'AHEE__Transactions_Admin_Page___send_payment_reminder__process_admin_payment_reminder',
+			$transaction
+		);
+		$this->_redirect_after_action(
+			false,
+			esc_html__('payment reminder', 'event_espresso'),
+			esc_html__('sent', 'event_espresso'),
+			$query_args,
+			true
+		);
+	}
+
+
+	/**
+	 *  get_transactions
+	 *    get transactions for given parameters (used by list table)
+	 *
+	 * @param int     $per_page how many transactions displayed per page
+	 * @param boolean $count   return the count or objects
+	 * @param string  $view
+	 * @return EE_Transaction[]|int int = count || array of transaction objects
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_transactions($per_page, $count = false, $view = '')
+	{
+		$start_date = wp_strip_all_tags(
+			$this->request->getRequestParam('txn-filter-start-date', date('m/d/Y', strtotime('-10 year')))
+		);
+		$end_date = wp_strip_all_tags(
+			$this->request->getRequestParam('txn-filter-end-date', date('m/d/Y'))
+		);
+
+		// make sure our timestamps start and end right at the boundaries for each day
+		$start_date = date('Y-m-d', strtotime($start_date)) . ' 00:00:00';
+		$end_date   = date('Y-m-d', strtotime($end_date)) . ' 23:59:59';
+
+
+		// convert to timestamps
+		$start_date = strtotime($start_date);
+		$end_date   = strtotime($end_date);
+
+		// makes sure start date is the lowest value and vice versa
+		$start_date = min($start_date, $end_date);
+		$end_date   = max($start_date, $end_date);
+
+		// convert to correct format for query
+		$start_date = EEM_Transaction::instance()->convert_datetime_for_query(
+			'TXN_timestamp',
+			date('Y-m-d H:i:s', $start_date),
+			'Y-m-d H:i:s'
+		);
+		$end_date   = EEM_Transaction::instance()->convert_datetime_for_query(
+			'TXN_timestamp',
+			date('Y-m-d H:i:s', $end_date),
+			'Y-m-d H:i:s'
+		);
+
+
+		// set orderby
+		$orderby = $this->request->getRequestParam('orderby');
+
+		switch ($orderby) {
+			case 'TXN_ID':
+				break;
+			case 'ATT_fname':
+				$orderby = 'Registration.Attendee.ATT_fname';
+				break;
+			case 'event_name':
+				$orderby = 'Registration.Event.EVT_name';
+				break;
+			default: // 'TXN_timestamp'
+				$orderby = 'TXN_timestamp';
+		}
+
+		$sort         = $this->request->getRequestParam('order', 'DESC');
+		$current_page = $this->request->getRequestParam('paged', 1, 'int');
+
+		$per_page = absint($per_page) ? $per_page : 10;
+		$per_page = $this->request->getRequestParam('perpage', $per_page, 'int');
+
+		$offset = ($current_page - 1) * $per_page;
+		$limit  = [$offset, $per_page];
+
+		$_where = [
+			'TXN_timestamp'          => ['BETWEEN', [$start_date, $end_date]],
+			'Registration.REG_count' => 1,
+		];
+
+		$EVT_ID = $this->request->getRequestParam('EVT_ID', 0, 'int');
+		if ($EVT_ID) {
+			$_where['Registration.EVT_ID'] = $EVT_ID;
+		}
+
+		$search_term = $this->request->getRequestParam('s');
+		if ($search_term) {
+			$search_term = '%' . $search_term . '%';
+			$_where['OR']  = [
+				'Registration.Event.EVT_name'         => ['LIKE', $search_term],
+				'Registration.Event.EVT_desc'         => ['LIKE', $search_term],
+				'Registration.Event.EVT_short_desc'   => ['LIKE', $search_term],
+				'Registration.Attendee.ATT_full_name' => ['LIKE', $search_term],
+				'Registration.Attendee.ATT_fname'     => ['LIKE', $search_term],
+				'Registration.Attendee.ATT_lname'     => ['LIKE', $search_term],
+				'Registration.Attendee.ATT_short_bio' => ['LIKE', $search_term],
+				'Registration.Attendee.ATT_email'     => ['LIKE', $search_term],
+				'Registration.Attendee.ATT_address'   => ['LIKE', $search_term],
+				'Registration.Attendee.ATT_address2'  => ['LIKE', $search_term],
+				'Registration.Attendee.ATT_city'      => ['LIKE', $search_term],
+				'Registration.REG_final_price'        => ['LIKE', $search_term],
+				'Registration.REG_code'               => ['LIKE', $search_term],
+				'Registration.REG_count'              => ['LIKE', $search_term],
+				'Registration.REG_group_size'         => ['LIKE', $search_term],
+				'Registration.Ticket.TKT_name'        => ['LIKE', $search_term],
+				'Registration.Ticket.TKT_description' => ['LIKE', $search_term],
+				'Payment.PAY_source'                  => ['LIKE', $search_term],
+				'Payment.Payment_Method.PMD_name'     => ['LIKE', $search_term],
+				'TXN_session_data'                    => ['LIKE', $search_term],
+				'Payment.PAY_txn_id_chq_nmbr'         => ['LIKE', $search_term],
+			];
+		}
+
+		$status = $this->request->getRequestParam('status');
+		// failed transactions
+		$failed     = (! empty($status) && $status === 'failed' && ! $count) || ($count && $view === 'failed');
+		$abandoned  = (! empty($status) && $status === 'abandoned' && ! $count) || ($count && $view === 'abandoned');
+		$incomplete = (! empty($status) && $status === 'incomplete' && ! $count) || ($count && $view === 'incomplete');
+
+		if ($failed) {
+			$_where['STS_ID'] = EEM_Transaction::failed_status_code;
+		} elseif ($abandoned) {
+			$_where['STS_ID'] = EEM_Transaction::abandoned_status_code;
+		} elseif ($incomplete) {
+			$_where['STS_ID'] = EEM_Transaction::incomplete_status_code;
+		} else {
+			$_where['STS_ID']  = ['!=', EEM_Transaction::failed_status_code];
+			$_where['STS_ID*'] = ['!=', EEM_Transaction::abandoned_status_code];
+		}
+
+		$query_params = apply_filters(
+			'FHEE__Transactions_Admin_Page___get_transactions_query_params',
+			[
+				$_where,
+				'order_by'                 => [$orderby => $sort],
+				'limit'                    => $limit,
+				'default_where_conditions' => EEM_Base::default_where_conditions_this_only,
+			],
+			$this->request->requestParams(),
+			$view,
+			$count
+		);
+
+		return $count
+			? EEM_Transaction::instance()->count([$query_params[0]], 'TXN_ID', true)
+			: EEM_Transaction::instance()->get_all($query_params);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @since 4.9.79.p
+	 */
+	public function recalculateLineItems()
+	{
+		$TXN_ID = $this->request->getRequestParam('TXN_ID', 0, 'int');
+		/** @var EE_Transaction $transaction */
+		$transaction     = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
+		$success         = $transaction->recalculateLineItems();
+		$redirect_to = $this->request->getRequestParam('redirect_to');
+		$query_args = $redirect_to ? ['action' => $redirect_to, 'TXN_ID' => $TXN_ID,] : [];
+		$this->_redirect_after_action(
+			$success,
+			esc_html__('Transaction taxes and totals', 'event_espresso'),
+			esc_html__('recalculated', 'event_espresso'),
+			$query_args,
+			true
+		);
+	}
 }

admin_pages/registration_form/Registration_Form_Admin_Page.core.php

Indentation +756 added lines, -756 removed lines

@@ -15,699 +15,699 @@ 
  */
 class Registration_Form_Admin_Page extends EE_Admin_Page
 {
-    /**
-     * holds the specific question object for the question details screen
-     *
-     * @var EE_Question $_question
-     */
-    protected $_question;
-
-    /**
-     * holds the specific question group object for the question group details screen
-     *
-     * @var EE_Question_Group $_question_group
-     */
-    protected $_question_group;
-
-    /**
-     *_question_model EEM_Question model instance (for queries)
-     *
-     * @var EEM_Question $_question_model ;
-     */
-    protected $_question_model;
-
-    /**
-     * _question_group_model EEM_Question_group instance (for queries)
-     *
-     * @var EEM_Question_Group $_question_group_model
-     */
-    protected $_question_group_model;
-
-
-    /**
-     * @Constructor
-     * @param bool $routing indicate whether we want to just load the object and handle routing or just load the object.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function __construct($routing = true)
-    {
-        require_once(EE_MODELS . 'EEM_Question.model.php');
-        require_once(EE_MODELS . 'EEM_Question_Group.model.php');
-        $this->_question_model       = EEM_Question::instance();
-        $this->_question_group_model = EEM_Question_Group::instance();
-        parent::__construct($routing);
-    }
-
-
-    protected function _init_page_props()
-    {
-        $this->page_slug        = REGISTRATION_FORM_PG_SLUG;
-        $this->page_label       = esc_html__('Registration Form', 'event_espresso');
-        $this->_admin_base_url  = REGISTRATION_FORM_ADMIN_URL;
-        $this->_admin_base_path = REGISTRATION_FORM_ADMIN;
-    }
-
-
-    protected function _ajax_hooks()
-    {
-    }
-
-
-    protected function _define_page_props()
-    {
-        $this->_admin_page_title = esc_html__('Registration Form', 'event_espresso');
-        $this->_labels           = [
-            'buttons' => [
-                'edit_question' => esc_html__('Edit Question', 'event_espresso'),
-            ],
-        ];
-    }
-
-
-    /**
-     *_set_page_routes
-     */
-    protected function _set_page_routes()
-    {
-        $qst_id             =
-            ! empty($this->_req_data['QST_ID'])
-                ? $this->_req_data['QST_ID']
-                : 0;
-        $this->_page_routes = [
-            'default' => [
-                'func'       => '_questions_overview_list_table',
-                'capability' => 'ee_read_questions',
-            ],
-
-            'edit_question' => [
-                'func'       => '_edit_question',
-                'capability' => 'ee_edit_question',
-                'obj_id'     => $qst_id,
-                'args'       => ['edit'],
-            ],
-
-            'question_groups' => [
-                'func'       => '_questions_groups_preview',
-                'capability' => 'ee_read_question_groups',
-            ],
-
-            'update_question' => [
-                'func'       => '_insert_or_update_question',
-                'args'       => ['new_question' => false],
-                'capability' => 'ee_edit_question',
-                'obj_id'     => $qst_id,
-                'noheader'   => true,
-            ],
-        ];
-    }
-
-
-    protected function _set_page_config()
-    {
-        $this->_page_config = [
-            'default' => [
-                'nav'           => [
-                    'label' =>  esc_html__('Questions', 'event_espresso'),
-                    'icon' => 'dashicons-editor-help',
-                    'order' => 10,
-                ],
-                'list_table'    => 'Registration_Form_Questions_Admin_List_Table',
-                'metaboxes'     => $this->_default_espresso_metaboxes,
-                'help_tabs'     => [
-                    'registration_form_questions_overview_help_tab'                           => [
-                        'title'    => esc_html__('Questions Overview', 'event_espresso'),
-                        'filename' => 'registration_form_questions_overview',
-                    ],
-                    'registration_form_questions_overview_table_column_headings_help_tab'     => [
-                        'title'    => esc_html__('Questions Overview Table Column Headings', 'event_espresso'),
-                        'filename' => 'registration_form_questions_overview_table_column_headings',
-                    ],
-                    'registration_form_questions_overview_views_bulk_actions_search_help_tab' => [
-                        'title'    => esc_html__('Question Overview Views & Bulk Actions & Search', 'event_espresso'),
-                        'filename' => 'registration_form_questions_overview_views_bulk_actions_search',
-                    ],
-                ],
-                'require_nonce' => false,
-            ],
-
-            'question_groups' => [
-                'nav'           => [
-                    'label' =>  esc_html__('Question Groups', 'event_espresso'),
-                    'icon' => 'dashicons-forms',
-                    'order' => 20,
-                ],
-                'metaboxes'     => $this->_default_espresso_metaboxes,
-                'help_tabs'     => [
-                    'registration_form_question_groups_help_tab' => [
-                        'title'    => esc_html__('Question Groups', 'event_espresso'),
-                        'filename' => 'registration_form_question_groups',
-                    ],
-                ],
-                'require_nonce' => false,
-            ],
-
-            'edit_question' => [
-                'nav'           => [
-                    'label'      => esc_html__('Edit Question', 'event_espresso'),
-                    'icon' => 'dashicons-edit-large',
-                    'order'      => 15,
-                    'persistent' => false,
-                    'url'        => isset($this->_req_data['question_id'])
-                        ? add_query_arg(
-                            ['question_id' => $this->_req_data['question_id']],
-                            $this->_current_page_view_url
-                        )
-                        : $this->_admin_base_url,
-                ],
-                'metaboxes'     => array_merge($this->_default_espresso_metaboxes, ['_publish_post_box']),
-                'help_tabs'     => [
-                    'registration_form_edit_question_group_help_tab' => [
-                        'title'    => esc_html__('Edit Question', 'event_espresso'),
-                        'filename' => 'registration_form_edit_question',
-                    ],
-                ],
-                'require_nonce' => false,
-            ],
-        ];
-    }
-
-
-    protected function _add_screen_options()
-    {
-        // todo
-    }
-
-
-    protected function _add_screen_options_default()
-    {
-        $page_title              = $this->_admin_page_title;
-        $this->_admin_page_title = esc_html__('Questions', 'event_espresso');
-        $this->_per_page_screen_option();
-        $this->_admin_page_title = $page_title;
-    }
-
-
-    protected function _add_screen_options_question_groups()
-    {
-        $page_title              = $this->_admin_page_title;
-        $this->_admin_page_title = esc_html__('Question Groups', 'event_espresso');
-        $this->_per_page_screen_option();
-        $this->_admin_page_title = $page_title;
-    }
-
-
-    // none of the below group are currently used for Event Categories
-    protected function _add_feature_pointers()
-    {
-    }
-
-
-    public function load_scripts_styles()
-    {
-        wp_register_style(
-            'espresso_registration',
-            REGISTRATION_FORM_ASSETS_URL . 'espresso_registration_form_admin.css',
-            [],
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('espresso_registration');
-    }
-
-
-    public function admin_init()
-    {
-    }
-
-
-    public function admin_notices()
-    {
-    }
-
-
-    public function admin_footer_scripts()
-    {
-    }
-
-
-    public function load_scripts_styles_default()
-    {
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    public function load_scripts_styles_add_question()
-    {
-        $this->load_scripts_styles_question_details();
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    public function load_scripts_styles_edit_question()
-    {
-        $this->load_scripts_styles_question_details();
-    }
-
-
-    /**
-     * Loads the JS required for adding or editing a question
-     *
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    protected function load_scripts_styles_question_details()
-    {
-        $this->load_scripts_styles_forms();
-        wp_register_script(
-            'espresso_registration_form_single',
-            REGISTRATION_FORM_ASSETS_URL . 'espresso_registration_form_admin.js',
-            ['jquery-ui-sortable'],
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_enqueue_script('espresso_registration_form_single');
-        wp_localize_script(
-            'espresso_registration_form_single',
-            'ee_question_data',
-            [
-                'question_types_with_max'    => EEM_Question::instance()->questionTypesWithMaxLength(),
-                'question_type_with_options' => EEM_Question::instance()->question_types_with_options(),
-            ]
-        );
-    }
-
-
-    public function recaptcha_info_help_tab()
-    {
-        $template = REGISTRATION_FORM_TEMPLATE_PATH . 'recaptcha_info_help_tab.template.php';
-        EEH_Template::display_template($template, []);
-    }
-
-
-    public function load_scripts_styles_forms()
-    {
-        // styles
-        wp_enqueue_style('espresso-ui-theme');
-        // scripts
-        wp_enqueue_script('ee_admin_js');
-    }
-
-
-    protected function _set_list_table_views_default()
-    {
-        $this->_views = [
-            'all' => [
-                'slug'  => 'all',
-                'label' => esc_html__('View All Questions', 'event_espresso'),
-                'count' => 0,
-            ],
-        ];
-
-        if (
-            EE_Registry::instance()->CAP->current_user_can(
-                'ee_delete_questions',
-                'espresso_registration_form_trash_questions'
-            )
-        ) {
-            $this->_views['trash'] = [
-                'slug'  => 'trash',
-                'label' => esc_html__('Trash', 'event_espresso'),
-                'count' => 0,
-            ];
-        }
-    }
-
-
-    /**
-     * This just previews the question groups tab that comes in caffeinated.
-     *
-     * @return void html
-     * @throws EE_Error
-     */
-    protected function _questions_groups_preview()
-    {
-        $this->_admin_page_title              = esc_html__('Question Groups (Preview)', 'event_espresso');
-        $this->_template_args['preview_img']  =
-            '<img src="' . REGISTRATION_FORM_ASSETS_URL . 'caf_reg_form_preview.jpg" alt="'
-            . esc_attr__(
-                'Preview Question Groups Overview List Table screenshot',
-                'event_espresso'
-            ) . '" />';
-        $this->_template_args['preview_text'] = '<strong>'
-                                                . esc_html__(
-                                                    'Question Groups is a feature that is only available in the premium version of Event Espresso 4 which is available with a support license purchase on EventEspresso.com. With the Question Groups feature you are able to create new question groups, edit existing question groups, and create and edit new questions and add them to question groups.',
-                                                    'event_espresso'
-                                                ) . '</strong>';
-        $this->display_admin_caf_preview_page('question_groups_tab');
-    }
-
-
-    /**
-     * Extracts the question field's values from the POST request to update or insert them
-     *
-     * @param EEM_Base $model
-     * @return array where each key is the name of a model's field/db column, and each value is its value.
-     * @throws EE_Error
-     */
-    protected function _set_column_values_for(EEM_Base $model)
-    {
-        $question_model = EEM_Question::instance();
-        $set_column_values = [];
-
-        // some initial checks for proper values.
-        // if QST_admin_only, then no matter what QST_required is we disable.
-        if (! empty($this->_req_data['QST_admin_only'])) {
-            $this->_req_data['QST_required'] = 0;
-        }
-        // if the question shouldn't have a max length, don't let them set one
-        if (
-            ! isset(
-                $this->_req_data['QST_type'],
-                $this->_req_data['QST_max']
-            )
-            || ! in_array(
-                $this->_req_data['QST_type'],
-                $question_model->questionTypesWithMaxLength(),
-                true
-            )
-        ) {
-            // they're not allowed to set the max
-            $this->_req_data['QST_max'] = null;
-        }
-        foreach ($model->field_settings() as $fieldName => $settings) {
-            // basically if QSG_identifier is empty or not set
-            if (
-                $fieldName === 'QSG_identifier'
-                && (isset($this->_req_data['QSG_identifier']) && empty($this->_req_data['QSG_identifier']))
-            ) {
-                $QSG_name = $this->_req_data['QSG_name'] ?? '';
-                $set_column_values[ $fieldName ] = sanitize_title($QSG_name) . '-' . uniqid('', true);
-            } elseif (
-                $fieldName === 'QST_admin_label'
-                && (isset($this->_req_data['QST_admin_label']) && empty($this->_req_data['QST_admin_label']))
-            ) {
-                // the admin label is blank, use a slug version of the question text
-                $QST_text = $this->_req_data['QST_display_text'] ?? '';
-                $set_column_values[ $fieldName ] = sanitize_title(wp_trim_words($QST_text, 10));
-            } elseif ($fieldName === 'QST_admin_only' && (! isset($this->_req_data['QST_admin_only']))) {
-                $set_column_values[ $fieldName ] = 0;
-            } elseif ($fieldName === 'QST_max') {
-                $qst_system = $question_model->get_var(
-                    [
-                        [
-                            'QST_ID' => $this->_req_data['QST_ID'] ?? 0,
-                        ],
-                    ],
-                    'QST_system'
-                );
-                $max_max    = $question_model->absolute_max_for_system_question((string) $qst_system);
-                if (empty($this->_req_data['QST_max']) || $this->_req_data['QST_max'] > $max_max) {
-                    $set_column_values[ $fieldName ] = $max_max;
-                }
-            }
-
-
-            // only add a property to the array if it's not null (otherwise the model should just use the default value)
-            if (
-                ! isset($set_column_values[ $fieldName ]) && isset($this->_req_data[ $fieldName ])
-            ) {
-                $set_column_values[ $fieldName ] = $this->_req_data[ $fieldName ];
-            }
-        }
-        // validation fo this data to be performed by the model before insertion.
-        return $set_column_values;
-    }
-
-
-    /**
-     *_questions_overview_list_table
-     *
-     * @throws EE_Error
-     */
-    protected function _questions_overview_list_table()
-    {
-        $this->_search_btn_label = esc_html__('Questions', 'event_espresso');
-        $this->display_admin_list_table_page_with_sidebar();
-    }
-
-
-    /**
-     * _edit_question
-     *
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _edit_question()
-    {
-        $ID = isset($this->_req_data['QST_ID']) && ! empty($this->_req_data['QST_ID'])
-            ? absint($this->_req_data['QST_ID'])
-            : false;
-
-        switch ($this->_req_action) {
-            case 'add_question':
-                $this->_admin_page_title = esc_html__('Add Question', 'event_espresso');
-                break;
-            case 'edit_question':
-                $this->_admin_page_title = esc_html__('Edit Question', 'event_espresso');
-                break;
-            default:
-                $this->_admin_page_title = ucwords(str_replace('_', ' ', $this->_req_action));
-        }
-
-        // add PRC_ID to title if editing
-        $this->_admin_page_title =
-            $ID
-                ? $this->_admin_page_title . ' # ' . $ID
-                : $this->_admin_page_title;
-        if ($ID) {
-            $question                 = $this->_question_model->get_one_by_ID($ID);
-            $additional_hidden_fields = ['QST_ID' => ['type' => 'hidden', 'value' => $ID]];
-            $this->_set_add_edit_form_tags('update_question', $additional_hidden_fields);
-        } else {
-            $question = EE_Question::new_instance();
-            $question->set_order_to_latest();
-            $this->_set_add_edit_form_tags('insert_question');
-        }
-        if ($question->system_ID() === EEM_Attendee::system_question_phone) {
-            $question_types = array_intersect_key(
-                EEM_Question::instance()->allowed_question_types(),
-                array_flip(
-                    [
-                        EEM_Question::QST_type_text,
-                        EEM_Question::QST_type_us_phone,
-                    ]
-                )
-            );
-        } else {
-            $question_types = $question->has_answers()
-                ? $this->_question_model->question_types_in_same_category($question->type())
-                : $this->_question_model->allowed_question_types();
-        }
-        $this->_template_args['QST_ID']                     = $ID;
-        $this->_template_args['question']                   = $question;
-        $this->_template_args['question_types']             = $question_types;
-        $this->_template_args['max_max']                    =
-            EEM_Question::instance()->absolute_max_for_system_question(
-                $question->system_ID()
-            );
-        $this->_template_args['question_type_descriptions'] = $this->_get_question_type_descriptions();
-        $this->_set_publish_post_box_vars('id', $ID);
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            REGISTRATION_FORM_TEMPLATE_PATH . 'questions_main_meta_box.template.php',
-            $this->_template_args,
-            true
-        );
-
-        // the details template wrapper
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _get_question_type_descriptions()
-    {
-        EE_Registry::instance()->load_helper('HTML');
-        $descriptions               = '';
-        $question_type_descriptions = EEM_Question::instance()->question_descriptions();
-        foreach ($question_type_descriptions as $type => $question_type_description) {
-            if ($type == 'HTML_TEXTAREA') {
-                $html                      = new EE_Simple_HTML_Validation_Strategy();
-                $question_type_description .= sprintf(
-                    esc_html__('%1$s(allowed tags: %2$s)', 'event_espresso'),
-                    '<br/>',
-                    $html->get_list_of_allowed_tags()
-                );
-            }
-            $descriptions .= EEH_HTML::p(
-                $question_type_description,
-                'question_type_description-' . $type,
-                'question_type_description description',
-                'display:none;'
-            );
-        }
-        return $descriptions;
-    }
-
-
-    /**
-     * @param bool|true $new_question
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _insert_or_update_question($new_question = true)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $set_column_values = $this->_set_column_values_for($this->_question_model);
-        if ($new_question) {
-            $question    = EE_Question::new_instance($set_column_values);
-            $action_desc = 'added';
-        } else {
-            $question = EEM_Question::instance()->get_one_by_ID(absint($this->_req_data['QST_ID']));
-            foreach ($set_column_values as $field => $new_value) {
-                $question->set($field, $new_value);
-            }
-            $action_desc = 'updated';
-        }
-        $success = $question->save();
-        $ID      = $question->ID();
-        if ($ID && $question->should_have_question_options()) {
-            // save the related options
-            // trash removed options, save old ones
-            // get list of all options
-            $options = $question->options();
-            if (! empty($options)) {
-                foreach ($options as $option_ID => $option) {
-                    $option_req_index = $this->_get_option_req_data_index($option_ID);
-                    if ($option_req_index !== false) {
-                        $option->save($this->_req_data['question_options'][ $option_req_index ]);
-                    } else {
-                        // not found, remove it
-                        $option->delete();
-                    }
-                }
-            }
-            // save new related options
-            foreach ($this->_req_data['question_options'] as $index => $option_req_data) {
-                // skip $index that is from our sample
-                if ($index === 'xxcountxx') {
-                    continue;
-                }
-                // note we allow saving blank options.
-                if (empty($option_req_data['QSO_ID'])) {
-                    // no ID! save it!
-                    $new_option = EE_Question_Option::new_instance(
-                        [
-                            'QSO_value' => $option_req_data['QSO_value'],
-                            'QSO_desc'  => $option_req_data['QSO_desc'],
-                            'QSO_order' => $option_req_data['QSO_order'],
-                            'QST_ID'    => $question->ID(),
-                        ]
-                    );
-                    $new_option->save();
-                }
-            }
-        }
-        $query_args = ['action' => 'edit_question', 'QST_ID' => $ID];
-        if ($success !== 0) {
-            $msg = $new_question
-                ? sprintf(
-                    esc_html__('The %s has been created', 'event_espresso'),
-                    $this->_question_model->item_name()
-                )
-                : sprintf(
-                    esc_html__('The %s has been updated', 'event_espresso'),
-                    $this->_question_model->item_name()
-                );
-            EE_Error::add_success($msg);
-        }
-
-        $this->_redirect_after_action(false, '', $action_desc, $query_args, true);
-    }
-
-
-    /**
-     * Upon saving a question, there should be an array of 'question_options'. This array is index numerically, but not
-     * by ID
-     * (this is done because new question options don't have an ID, but we may want to add multiple simultaneously).
-     * So, this function gets the index in that request data array called question_options. Returns FALSE if not found.
-     *
-     * @param int $ID of the question option to find
-     * @return int index in question_options array if successful, FALSE if unsuccessful
-     */
-    protected function _get_option_req_data_index($ID)
-    {
-        $req_data_for_question_options = $this->_req_data['question_options'];
-        foreach ($req_data_for_question_options as $num => $option_data) {
-            if (array_key_exists('QSO_ID', $option_data) && (int) $option_data['QSO_ID'] === $ID) {
-                return $num;
-            }
-        }
-        return false;
-    }
-
-
-
-
-    /***********/
-    /* QUERIES */
-    /**
-     * For internal use in getting all the query parameters
-     * (because it's pretty well the same between question, question groups,
-     * and for both when searching for trashed and untrashed ones)
-     *
-     * @param EEM_Base $model either EEM_Question or EEM_Question_Group
-     * @param int      $per_page
-     * @param int      $current_page
-     * @return array model query params, @see
-     *               https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    protected function get_query_params($model, $per_page = 10, $current_page = 10)
-    {
-        $query_params             = [];
-        $offset                   = ($current_page - 1) * $per_page;
-        $query_params['limit']    = [$offset, $per_page];
-        $order                    =
-            (isset($this->_req_data['order']) && ! empty($this->_req_data['order']))
-                ? $this->_req_data['order']
-                : 'ASC';
-        $orderby_field            =
-            $model instanceof EEM_Question
-                ? 'QST_ID'
-                : 'QSG_order';
-        $field_to_order_by        =
-            empty($this->_req_data['orderby'])
-                ? $orderby_field
-                : $this->_req_data['orderby'];
-        $query_params['order_by'] = [$field_to_order_by => $order];
-        $search_string            =
-            array_key_exists('s', $this->_req_data)
-                ? $this->_req_data['s']
-                : null;
-        if (! empty($search_string)) {
-            if ($model instanceof EEM_Question_Group) {
-                $query_params[0] = [
-                    'OR' => [
-                        'QSG_name' => ['LIKE', "%$search_string%"],
-                        'QSG_desc' => ['LIKE', "%$search_string%"],
-                    ],
-                ];
-            } else {
-                $query_params[0] = [
-                    'QST_display_text' => ['LIKE', "%$search_string%"],
-                ];
-            }
-        }
-
-        // capability checks (just leaving this commented out for reference because it illustrates some complicated query params that could be useful when fully implemented)
-        /*if ( $model instanceof EEM_Question_Group ) {
+	/**
+	 * holds the specific question object for the question details screen
+	 *
+	 * @var EE_Question $_question
+	 */
+	protected $_question;
+
+	/**
+	 * holds the specific question group object for the question group details screen
+	 *
+	 * @var EE_Question_Group $_question_group
+	 */
+	protected $_question_group;
+
+	/**
+	 *_question_model EEM_Question model instance (for queries)
+	 *
+	 * @var EEM_Question $_question_model ;
+	 */
+	protected $_question_model;
+
+	/**
+	 * _question_group_model EEM_Question_group instance (for queries)
+	 *
+	 * @var EEM_Question_Group $_question_group_model
+	 */
+	protected $_question_group_model;
+
+
+	/**
+	 * @Constructor
+	 * @param bool $routing indicate whether we want to just load the object and handle routing or just load the object.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function __construct($routing = true)
+	{
+		require_once(EE_MODELS . 'EEM_Question.model.php');
+		require_once(EE_MODELS . 'EEM_Question_Group.model.php');
+		$this->_question_model       = EEM_Question::instance();
+		$this->_question_group_model = EEM_Question_Group::instance();
+		parent::__construct($routing);
+	}
+
+
+	protected function _init_page_props()
+	{
+		$this->page_slug        = REGISTRATION_FORM_PG_SLUG;
+		$this->page_label       = esc_html__('Registration Form', 'event_espresso');
+		$this->_admin_base_url  = REGISTRATION_FORM_ADMIN_URL;
+		$this->_admin_base_path = REGISTRATION_FORM_ADMIN;
+	}
+
+
+	protected function _ajax_hooks()
+	{
+	}
+
+
+	protected function _define_page_props()
+	{
+		$this->_admin_page_title = esc_html__('Registration Form', 'event_espresso');
+		$this->_labels           = [
+			'buttons' => [
+				'edit_question' => esc_html__('Edit Question', 'event_espresso'),
+			],
+		];
+	}
+
+
+	/**
+	 *_set_page_routes
+	 */
+	protected function _set_page_routes()
+	{
+		$qst_id             =
+			! empty($this->_req_data['QST_ID'])
+				? $this->_req_data['QST_ID']
+				: 0;
+		$this->_page_routes = [
+			'default' => [
+				'func'       => '_questions_overview_list_table',
+				'capability' => 'ee_read_questions',
+			],
+
+			'edit_question' => [
+				'func'       => '_edit_question',
+				'capability' => 'ee_edit_question',
+				'obj_id'     => $qst_id,
+				'args'       => ['edit'],
+			],
+
+			'question_groups' => [
+				'func'       => '_questions_groups_preview',
+				'capability' => 'ee_read_question_groups',
+			],
+
+			'update_question' => [
+				'func'       => '_insert_or_update_question',
+				'args'       => ['new_question' => false],
+				'capability' => 'ee_edit_question',
+				'obj_id'     => $qst_id,
+				'noheader'   => true,
+			],
+		];
+	}
+
+
+	protected function _set_page_config()
+	{
+		$this->_page_config = [
+			'default' => [
+				'nav'           => [
+					'label' =>  esc_html__('Questions', 'event_espresso'),
+					'icon' => 'dashicons-editor-help',
+					'order' => 10,
+				],
+				'list_table'    => 'Registration_Form_Questions_Admin_List_Table',
+				'metaboxes'     => $this->_default_espresso_metaboxes,
+				'help_tabs'     => [
+					'registration_form_questions_overview_help_tab'                           => [
+						'title'    => esc_html__('Questions Overview', 'event_espresso'),
+						'filename' => 'registration_form_questions_overview',
+					],
+					'registration_form_questions_overview_table_column_headings_help_tab'     => [
+						'title'    => esc_html__('Questions Overview Table Column Headings', 'event_espresso'),
+						'filename' => 'registration_form_questions_overview_table_column_headings',
+					],
+					'registration_form_questions_overview_views_bulk_actions_search_help_tab' => [
+						'title'    => esc_html__('Question Overview Views & Bulk Actions & Search', 'event_espresso'),
+						'filename' => 'registration_form_questions_overview_views_bulk_actions_search',
+					],
+				],
+				'require_nonce' => false,
+			],
+
+			'question_groups' => [
+				'nav'           => [
+					'label' =>  esc_html__('Question Groups', 'event_espresso'),
+					'icon' => 'dashicons-forms',
+					'order' => 20,
+				],
+				'metaboxes'     => $this->_default_espresso_metaboxes,
+				'help_tabs'     => [
+					'registration_form_question_groups_help_tab' => [
+						'title'    => esc_html__('Question Groups', 'event_espresso'),
+						'filename' => 'registration_form_question_groups',
+					],
+				],
+				'require_nonce' => false,
+			],
+
+			'edit_question' => [
+				'nav'           => [
+					'label'      => esc_html__('Edit Question', 'event_espresso'),
+					'icon' => 'dashicons-edit-large',
+					'order'      => 15,
+					'persistent' => false,
+					'url'        => isset($this->_req_data['question_id'])
+						? add_query_arg(
+							['question_id' => $this->_req_data['question_id']],
+							$this->_current_page_view_url
+						)
+						: $this->_admin_base_url,
+				],
+				'metaboxes'     => array_merge($this->_default_espresso_metaboxes, ['_publish_post_box']),
+				'help_tabs'     => [
+					'registration_form_edit_question_group_help_tab' => [
+						'title'    => esc_html__('Edit Question', 'event_espresso'),
+						'filename' => 'registration_form_edit_question',
+					],
+				],
+				'require_nonce' => false,
+			],
+		];
+	}
+
+
+	protected function _add_screen_options()
+	{
+		// todo
+	}
+
+
+	protected function _add_screen_options_default()
+	{
+		$page_title              = $this->_admin_page_title;
+		$this->_admin_page_title = esc_html__('Questions', 'event_espresso');
+		$this->_per_page_screen_option();
+		$this->_admin_page_title = $page_title;
+	}
+
+
+	protected function _add_screen_options_question_groups()
+	{
+		$page_title              = $this->_admin_page_title;
+		$this->_admin_page_title = esc_html__('Question Groups', 'event_espresso');
+		$this->_per_page_screen_option();
+		$this->_admin_page_title = $page_title;
+	}
+
+
+	// none of the below group are currently used for Event Categories
+	protected function _add_feature_pointers()
+	{
+	}
+
+
+	public function load_scripts_styles()
+	{
+		wp_register_style(
+			'espresso_registration',
+			REGISTRATION_FORM_ASSETS_URL . 'espresso_registration_form_admin.css',
+			[],
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('espresso_registration');
+	}
+
+
+	public function admin_init()
+	{
+	}
+
+
+	public function admin_notices()
+	{
+	}
+
+
+	public function admin_footer_scripts()
+	{
+	}
+
+
+	public function load_scripts_styles_default()
+	{
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	public function load_scripts_styles_add_question()
+	{
+		$this->load_scripts_styles_question_details();
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	public function load_scripts_styles_edit_question()
+	{
+		$this->load_scripts_styles_question_details();
+	}
+
+
+	/**
+	 * Loads the JS required for adding or editing a question
+	 *
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	protected function load_scripts_styles_question_details()
+	{
+		$this->load_scripts_styles_forms();
+		wp_register_script(
+			'espresso_registration_form_single',
+			REGISTRATION_FORM_ASSETS_URL . 'espresso_registration_form_admin.js',
+			['jquery-ui-sortable'],
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_enqueue_script('espresso_registration_form_single');
+		wp_localize_script(
+			'espresso_registration_form_single',
+			'ee_question_data',
+			[
+				'question_types_with_max'    => EEM_Question::instance()->questionTypesWithMaxLength(),
+				'question_type_with_options' => EEM_Question::instance()->question_types_with_options(),
+			]
+		);
+	}
+
+
+	public function recaptcha_info_help_tab()
+	{
+		$template = REGISTRATION_FORM_TEMPLATE_PATH . 'recaptcha_info_help_tab.template.php';
+		EEH_Template::display_template($template, []);
+	}
+
+
+	public function load_scripts_styles_forms()
+	{
+		// styles
+		wp_enqueue_style('espresso-ui-theme');
+		// scripts
+		wp_enqueue_script('ee_admin_js');
+	}
+
+
+	protected function _set_list_table_views_default()
+	{
+		$this->_views = [
+			'all' => [
+				'slug'  => 'all',
+				'label' => esc_html__('View All Questions', 'event_espresso'),
+				'count' => 0,
+			],
+		];
+
+		if (
+			EE_Registry::instance()->CAP->current_user_can(
+				'ee_delete_questions',
+				'espresso_registration_form_trash_questions'
+			)
+		) {
+			$this->_views['trash'] = [
+				'slug'  => 'trash',
+				'label' => esc_html__('Trash', 'event_espresso'),
+				'count' => 0,
+			];
+		}
+	}
+
+
+	/**
+	 * This just previews the question groups tab that comes in caffeinated.
+	 *
+	 * @return void html
+	 * @throws EE_Error
+	 */
+	protected function _questions_groups_preview()
+	{
+		$this->_admin_page_title              = esc_html__('Question Groups (Preview)', 'event_espresso');
+		$this->_template_args['preview_img']  =
+			'<img src="' . REGISTRATION_FORM_ASSETS_URL . 'caf_reg_form_preview.jpg" alt="'
+			. esc_attr__(
+				'Preview Question Groups Overview List Table screenshot',
+				'event_espresso'
+			) . '" />';
+		$this->_template_args['preview_text'] = '<strong>'
+												. esc_html__(
+													'Question Groups is a feature that is only available in the premium version of Event Espresso 4 which is available with a support license purchase on EventEspresso.com. With the Question Groups feature you are able to create new question groups, edit existing question groups, and create and edit new questions and add them to question groups.',
+													'event_espresso'
+												) . '</strong>';
+		$this->display_admin_caf_preview_page('question_groups_tab');
+	}
+
+
+	/**
+	 * Extracts the question field's values from the POST request to update or insert them
+	 *
+	 * @param EEM_Base $model
+	 * @return array where each key is the name of a model's field/db column, and each value is its value.
+	 * @throws EE_Error
+	 */
+	protected function _set_column_values_for(EEM_Base $model)
+	{
+		$question_model = EEM_Question::instance();
+		$set_column_values = [];
+
+		// some initial checks for proper values.
+		// if QST_admin_only, then no matter what QST_required is we disable.
+		if (! empty($this->_req_data['QST_admin_only'])) {
+			$this->_req_data['QST_required'] = 0;
+		}
+		// if the question shouldn't have a max length, don't let them set one
+		if (
+			! isset(
+				$this->_req_data['QST_type'],
+				$this->_req_data['QST_max']
+			)
+			|| ! in_array(
+				$this->_req_data['QST_type'],
+				$question_model->questionTypesWithMaxLength(),
+				true
+			)
+		) {
+			// they're not allowed to set the max
+			$this->_req_data['QST_max'] = null;
+		}
+		foreach ($model->field_settings() as $fieldName => $settings) {
+			// basically if QSG_identifier is empty or not set
+			if (
+				$fieldName === 'QSG_identifier'
+				&& (isset($this->_req_data['QSG_identifier']) && empty($this->_req_data['QSG_identifier']))
+			) {
+				$QSG_name = $this->_req_data['QSG_name'] ?? '';
+				$set_column_values[ $fieldName ] = sanitize_title($QSG_name) . '-' . uniqid('', true);
+			} elseif (
+				$fieldName === 'QST_admin_label'
+				&& (isset($this->_req_data['QST_admin_label']) && empty($this->_req_data['QST_admin_label']))
+			) {
+				// the admin label is blank, use a slug version of the question text
+				$QST_text = $this->_req_data['QST_display_text'] ?? '';
+				$set_column_values[ $fieldName ] = sanitize_title(wp_trim_words($QST_text, 10));
+			} elseif ($fieldName === 'QST_admin_only' && (! isset($this->_req_data['QST_admin_only']))) {
+				$set_column_values[ $fieldName ] = 0;
+			} elseif ($fieldName === 'QST_max') {
+				$qst_system = $question_model->get_var(
+					[
+						[
+							'QST_ID' => $this->_req_data['QST_ID'] ?? 0,
+						],
+					],
+					'QST_system'
+				);
+				$max_max    = $question_model->absolute_max_for_system_question((string) $qst_system);
+				if (empty($this->_req_data['QST_max']) || $this->_req_data['QST_max'] > $max_max) {
+					$set_column_values[ $fieldName ] = $max_max;
+				}
+			}
+
+
+			// only add a property to the array if it's not null (otherwise the model should just use the default value)
+			if (
+				! isset($set_column_values[ $fieldName ]) && isset($this->_req_data[ $fieldName ])
+			) {
+				$set_column_values[ $fieldName ] = $this->_req_data[ $fieldName ];
+			}
+		}
+		// validation fo this data to be performed by the model before insertion.
+		return $set_column_values;
+	}
+
+
+	/**
+	 *_questions_overview_list_table
+	 *
+	 * @throws EE_Error
+	 */
+	protected function _questions_overview_list_table()
+	{
+		$this->_search_btn_label = esc_html__('Questions', 'event_espresso');
+		$this->display_admin_list_table_page_with_sidebar();
+	}
+
+
+	/**
+	 * _edit_question
+	 *
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _edit_question()
+	{
+		$ID = isset($this->_req_data['QST_ID']) && ! empty($this->_req_data['QST_ID'])
+			? absint($this->_req_data['QST_ID'])
+			: false;
+
+		switch ($this->_req_action) {
+			case 'add_question':
+				$this->_admin_page_title = esc_html__('Add Question', 'event_espresso');
+				break;
+			case 'edit_question':
+				$this->_admin_page_title = esc_html__('Edit Question', 'event_espresso');
+				break;
+			default:
+				$this->_admin_page_title = ucwords(str_replace('_', ' ', $this->_req_action));
+		}
+
+		// add PRC_ID to title if editing
+		$this->_admin_page_title =
+			$ID
+				? $this->_admin_page_title . ' # ' . $ID
+				: $this->_admin_page_title;
+		if ($ID) {
+			$question                 = $this->_question_model->get_one_by_ID($ID);
+			$additional_hidden_fields = ['QST_ID' => ['type' => 'hidden', 'value' => $ID]];
+			$this->_set_add_edit_form_tags('update_question', $additional_hidden_fields);
+		} else {
+			$question = EE_Question::new_instance();
+			$question->set_order_to_latest();
+			$this->_set_add_edit_form_tags('insert_question');
+		}
+		if ($question->system_ID() === EEM_Attendee::system_question_phone) {
+			$question_types = array_intersect_key(
+				EEM_Question::instance()->allowed_question_types(),
+				array_flip(
+					[
+						EEM_Question::QST_type_text,
+						EEM_Question::QST_type_us_phone,
+					]
+				)
+			);
+		} else {
+			$question_types = $question->has_answers()
+				? $this->_question_model->question_types_in_same_category($question->type())
+				: $this->_question_model->allowed_question_types();
+		}
+		$this->_template_args['QST_ID']                     = $ID;
+		$this->_template_args['question']                   = $question;
+		$this->_template_args['question_types']             = $question_types;
+		$this->_template_args['max_max']                    =
+			EEM_Question::instance()->absolute_max_for_system_question(
+				$question->system_ID()
+			);
+		$this->_template_args['question_type_descriptions'] = $this->_get_question_type_descriptions();
+		$this->_set_publish_post_box_vars('id', $ID);
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			REGISTRATION_FORM_TEMPLATE_PATH . 'questions_main_meta_box.template.php',
+			$this->_template_args,
+			true
+		);
+
+		// the details template wrapper
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _get_question_type_descriptions()
+	{
+		EE_Registry::instance()->load_helper('HTML');
+		$descriptions               = '';
+		$question_type_descriptions = EEM_Question::instance()->question_descriptions();
+		foreach ($question_type_descriptions as $type => $question_type_description) {
+			if ($type == 'HTML_TEXTAREA') {
+				$html                      = new EE_Simple_HTML_Validation_Strategy();
+				$question_type_description .= sprintf(
+					esc_html__('%1$s(allowed tags: %2$s)', 'event_espresso'),
+					'<br/>',
+					$html->get_list_of_allowed_tags()
+				);
+			}
+			$descriptions .= EEH_HTML::p(
+				$question_type_description,
+				'question_type_description-' . $type,
+				'question_type_description description',
+				'display:none;'
+			);
+		}
+		return $descriptions;
+	}
+
+
+	/**
+	 * @param bool|true $new_question
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _insert_or_update_question($new_question = true)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$set_column_values = $this->_set_column_values_for($this->_question_model);
+		if ($new_question) {
+			$question    = EE_Question::new_instance($set_column_values);
+			$action_desc = 'added';
+		} else {
+			$question = EEM_Question::instance()->get_one_by_ID(absint($this->_req_data['QST_ID']));
+			foreach ($set_column_values as $field => $new_value) {
+				$question->set($field, $new_value);
+			}
+			$action_desc = 'updated';
+		}
+		$success = $question->save();
+		$ID      = $question->ID();
+		if ($ID && $question->should_have_question_options()) {
+			// save the related options
+			// trash removed options, save old ones
+			// get list of all options
+			$options = $question->options();
+			if (! empty($options)) {
+				foreach ($options as $option_ID => $option) {
+					$option_req_index = $this->_get_option_req_data_index($option_ID);
+					if ($option_req_index !== false) {
+						$option->save($this->_req_data['question_options'][ $option_req_index ]);
+					} else {
+						// not found, remove it
+						$option->delete();
+					}
+				}
+			}
+			// save new related options
+			foreach ($this->_req_data['question_options'] as $index => $option_req_data) {
+				// skip $index that is from our sample
+				if ($index === 'xxcountxx') {
+					continue;
+				}
+				// note we allow saving blank options.
+				if (empty($option_req_data['QSO_ID'])) {
+					// no ID! save it!
+					$new_option = EE_Question_Option::new_instance(
+						[
+							'QSO_value' => $option_req_data['QSO_value'],
+							'QSO_desc'  => $option_req_data['QSO_desc'],
+							'QSO_order' => $option_req_data['QSO_order'],
+							'QST_ID'    => $question->ID(),
+						]
+					);
+					$new_option->save();
+				}
+			}
+		}
+		$query_args = ['action' => 'edit_question', 'QST_ID' => $ID];
+		if ($success !== 0) {
+			$msg = $new_question
+				? sprintf(
+					esc_html__('The %s has been created', 'event_espresso'),
+					$this->_question_model->item_name()
+				)
+				: sprintf(
+					esc_html__('The %s has been updated', 'event_espresso'),
+					$this->_question_model->item_name()
+				);
+			EE_Error::add_success($msg);
+		}
+
+		$this->_redirect_after_action(false, '', $action_desc, $query_args, true);
+	}
+
+
+	/**
+	 * Upon saving a question, there should be an array of 'question_options'. This array is index numerically, but not
+	 * by ID
+	 * (this is done because new question options don't have an ID, but we may want to add multiple simultaneously).
+	 * So, this function gets the index in that request data array called question_options. Returns FALSE if not found.
+	 *
+	 * @param int $ID of the question option to find
+	 * @return int index in question_options array if successful, FALSE if unsuccessful
+	 */
+	protected function _get_option_req_data_index($ID)
+	{
+		$req_data_for_question_options = $this->_req_data['question_options'];
+		foreach ($req_data_for_question_options as $num => $option_data) {
+			if (array_key_exists('QSO_ID', $option_data) && (int) $option_data['QSO_ID'] === $ID) {
+				return $num;
+			}
+		}
+		return false;
+	}
+
+
+
+
+	/***********/
+	/* QUERIES */
+	/**
+	 * For internal use in getting all the query parameters
+	 * (because it's pretty well the same between question, question groups,
+	 * and for both when searching for trashed and untrashed ones)
+	 *
+	 * @param EEM_Base $model either EEM_Question or EEM_Question_Group
+	 * @param int      $per_page
+	 * @param int      $current_page
+	 * @return array model query params, @see
+	 *               https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	protected function get_query_params($model, $per_page = 10, $current_page = 10)
+	{
+		$query_params             = [];
+		$offset                   = ($current_page - 1) * $per_page;
+		$query_params['limit']    = [$offset, $per_page];
+		$order                    =
+			(isset($this->_req_data['order']) && ! empty($this->_req_data['order']))
+				? $this->_req_data['order']
+				: 'ASC';
+		$orderby_field            =
+			$model instanceof EEM_Question
+				? 'QST_ID'
+				: 'QSG_order';
+		$field_to_order_by        =
+			empty($this->_req_data['orderby'])
+				? $orderby_field
+				: $this->_req_data['orderby'];
+		$query_params['order_by'] = [$field_to_order_by => $order];
+		$search_string            =
+			array_key_exists('s', $this->_req_data)
+				? $this->_req_data['s']
+				: null;
+		if (! empty($search_string)) {
+			if ($model instanceof EEM_Question_Group) {
+				$query_params[0] = [
+					'OR' => [
+						'QSG_name' => ['LIKE', "%$search_string%"],
+						'QSG_desc' => ['LIKE', "%$search_string%"],
+					],
+				];
+			} else {
+				$query_params[0] = [
+					'QST_display_text' => ['LIKE', "%$search_string%"],
+				];
+			}
+		}
+
+		// capability checks (just leaving this commented out for reference because it illustrates some complicated query params that could be useful when fully implemented)
+		/*if ( $model instanceof EEM_Question_Group ) {
             if ( ! EE_Registry::instance()->CAP->current_user_can( 'edit_others_question_groups', 'espresso_registration_form_edit_question_group' ) ) {
                 $query_params[0] = array(
                     'AND' => array(
@@ -737,67 +737,67 @@ 
             }
         }/**/
 
-        return $query_params;
-    }
-
-
-    /**
-     * @param int        $per_page
-     * @param int        $current_page
-     * @param bool|false $count
-     * @return EE_Base_Class[]|EE_Question_Group[]|EE_Soft_Delete_Base_Class[]|int
-     * @throws EE_Error
-     */
-    public function get_questions($per_page = 10, $current_page = 1, $count = false)
-    {
-        $QST          = EEM_Question::instance();
-        $query_params = $this->get_query_params($QST, $per_page, $current_page);
-        if ($count) {
-            $where   =
-                isset($query_params[0])
-                    ? [$query_params[0]]
-                    : [];
-            $results = $QST->count($where);
-        } else {
-            $results = $QST->get_all($query_params);
-        }
-        return $results;
-    }
-
-
-    /**
-     * @param            $per_page
-     * @param int        $current_page
-     * @param bool|false $count
-     * @return EE_Soft_Delete_Base_Class[]|int
-     * @throws EE_Error
-     */
-    public function get_trashed_questions($per_page, $current_page = 1, $count = false)
-    {
-        $query_params = $this->get_query_params(EEM_Question::instance(), $per_page, $current_page);
-        $where        =
-            isset($query_params[0])
-                ? [$query_params[0]]
-                : [];
-        return $count
-            ? EEM_Question::instance()->count_deleted($where)
-            : EEM_Question::instance()->get_all_deleted($query_params);
-    }
-
-
-    /**
-     * @param            $per_page
-     * @param int        $current_page
-     * @param bool|false $count
-     * @return EE_Base_Class[]|EE_Question_Group[]|EE_Soft_Delete_Base_Class[]
-     * @throws EE_Error
-     */
-    public function get_question_groups($per_page, $current_page = 1, $count = false)
-    {
-        $questionGroupModel = EEM_Question_Group::instance();
-        // note: this a subclass of EEM_Soft_Delete_Base, so this is actually only getting non-trashed items
-        return $questionGroupModel->get_all(
-            $this->get_query_params($questionGroupModel, $per_page, $current_page)
-        );
-    }
+		return $query_params;
+	}
+
+
+	/**
+	 * @param int        $per_page
+	 * @param int        $current_page
+	 * @param bool|false $count
+	 * @return EE_Base_Class[]|EE_Question_Group[]|EE_Soft_Delete_Base_Class[]|int
+	 * @throws EE_Error
+	 */
+	public function get_questions($per_page = 10, $current_page = 1, $count = false)
+	{
+		$QST          = EEM_Question::instance();
+		$query_params = $this->get_query_params($QST, $per_page, $current_page);
+		if ($count) {
+			$where   =
+				isset($query_params[0])
+					? [$query_params[0]]
+					: [];
+			$results = $QST->count($where);
+		} else {
+			$results = $QST->get_all($query_params);
+		}
+		return $results;
+	}
+
+
+	/**
+	 * @param            $per_page
+	 * @param int        $current_page
+	 * @param bool|false $count
+	 * @return EE_Soft_Delete_Base_Class[]|int
+	 * @throws EE_Error
+	 */
+	public function get_trashed_questions($per_page, $current_page = 1, $count = false)
+	{
+		$query_params = $this->get_query_params(EEM_Question::instance(), $per_page, $current_page);
+		$where        =
+			isset($query_params[0])
+				? [$query_params[0]]
+				: [];
+		return $count
+			? EEM_Question::instance()->count_deleted($where)
+			: EEM_Question::instance()->get_all_deleted($query_params);
+	}
+
+
+	/**
+	 * @param            $per_page
+	 * @param int        $current_page
+	 * @param bool|false $count
+	 * @return EE_Base_Class[]|EE_Question_Group[]|EE_Soft_Delete_Base_Class[]
+	 * @throws EE_Error
+	 */
+	public function get_question_groups($per_page, $current_page = 1, $count = false)
+	{
+		$questionGroupModel = EEM_Question_Group::instance();
+		// note: this a subclass of EEM_Soft_Delete_Base, so this is actually only getting non-trashed items
+		return $questionGroupModel->get_all(
+			$this->get_query_params($questionGroupModel, $per_page, $current_page)
+		);
+	}
 }

admin_pages/events/Events_Admin_Page.core.php

Indentation +2916 added lines, -2916 removed lines

@@ -16,2923 +16,2923 @@
  */
 class Events_Admin_Page extends EE_Admin_Page_CPT
 {
-    /**
-     * This will hold the event object for event_details screen.
+	/**
+	 * This will hold the event object for event_details screen.
+	 *
+	 * @var EE_Event $_event
+	 */
+	protected $_event;
+
+
+	/**
+	 * This will hold the category object for category_details screen.
+	 *
+	 * @var stdClass $_category
+	 */
+	protected $_category;
+
+
+	/**
+	 * This will hold the event model instance
+	 *
+	 * @var EEM_Event $_event_model
+	 */
+	protected $_event_model;
+
+
+	/**
+	 * @var EE_Event
+	 */
+	protected $_cpt_model_obj = false;
+
+
+	/**
+	 * @var NodeGroupDao
+	 */
+	protected $model_obj_node_group_persister;
+
+	/**
+	 * @var AdvancedEditorAdminFormSection
+	 */
+	protected $advanced_editor_admin_form;
+
+
+	/**
+	 * Initialize page props for this admin page group.
+	 */
+	protected function _init_page_props()
+	{
+		$this->page_slug        = EVENTS_PG_SLUG;
+		$this->page_label       = EVENTS_LABEL;
+		$this->_admin_base_url  = EVENTS_ADMIN_URL;
+		$this->_admin_base_path = EVENTS_ADMIN;
+		$this->_cpt_model_names = [
+			'create_new' => 'EEM_Event',
+			'edit'       => 'EEM_Event',
+		];
+		$this->_cpt_edit_routes = [
+			'espresso_events' => 'edit',
+		];
+		add_action(
+			'AHEE__EE_Admin_Page_CPT__set_model_object__after_set_object',
+			[$this, 'verify_event_edit'],
+			10,
+			2
+		);
+	}
+
+
+	/**
+	 * Sets the ajax hooks used for this admin page group.
+	 */
+	protected function _ajax_hooks()
+	{
+		add_action('wp_ajax_ee_save_timezone_setting', [$this, 'saveTimezoneString']);
+	}
+
+
+	/**
+	 * Sets the page properties for this admin page group.
+	 */
+	protected function _define_page_props()
+	{
+		$this->_admin_page_title = EVENTS_LABEL;
+		$this->_labels           = [
+			'buttons'      => [
+				'add'             => esc_html__('Add New Event', 'event_espresso'),
+				'edit'            => esc_html__('Edit Event', 'event_espresso'),
+				'delete'          => esc_html__('Delete Event', 'event_espresso'),
+				'add_category'    => esc_html__('Add New Category', 'event_espresso'),
+				'edit_category'   => esc_html__('Edit Category', 'event_espresso'),
+				'delete_category' => esc_html__('Delete Category', 'event_espresso'),
+			],
+			'editor_title' => [
+				'espresso_events' => esc_html__('Enter event title here', 'event_espresso'),
+			],
+			'publishbox'   => [
+				'create_new'        => esc_html__('Save New Event', 'event_espresso'),
+				'edit'              => esc_html__('Update Event', 'event_espresso'),
+				'add_category'      => esc_html__('Save New Category', 'event_espresso'),
+				'edit_category'     => esc_html__('Update Category', 'event_espresso'),
+				'template_settings' => esc_html__('Update Settings', 'event_espresso'),
+			],
+		];
+	}
+
+
+	/**
+	 * Sets the page routes property for this admin page group.
+	 */
+	protected function _set_page_routes()
+	{
+		// load formatter helper
+		// load field generator helper
+		// is there a evt_id in the request?
+		$EVT_ID = $this->request->getRequestParam('EVT_ID', 0, 'int');
+		$EVT_ID = $this->request->getRequestParam('post', $EVT_ID, 'int');
+
+		$this->_page_routes = [
+			'default'                       => [
+				'func'       => '_events_overview_list_table',
+				'capability' => 'ee_read_events',
+			],
+			'create_new'                    => [
+				'func'       => '_create_new_cpt_item',
+				'capability' => 'ee_edit_events',
+			],
+			'edit'                          => [
+				'func'       => '_edit_cpt_item',
+				'capability' => 'ee_edit_event',
+				'obj_id'     => $EVT_ID,
+			],
+			'copy_event'                    => [
+				'func'       => '_copy_events',
+				'capability' => 'ee_edit_event',
+				'obj_id'     => $EVT_ID,
+				'noheader'   => true,
+			],
+			'trash_event'                   => [
+				'func'       => '_trash_or_restore_event',
+				'args'       => ['event_status' => 'trash'],
+				'capability' => 'ee_delete_event',
+				'obj_id'     => $EVT_ID,
+				'noheader'   => true,
+			],
+			'trash_events'                  => [
+				'func'       => '_trash_or_restore_events',
+				'args'       => ['event_status' => 'trash'],
+				'capability' => 'ee_delete_events',
+				'noheader'   => true,
+			],
+			'restore_event'                 => [
+				'func'       => '_trash_or_restore_event',
+				'args'       => ['event_status' => 'draft'],
+				'capability' => 'ee_delete_event',
+				'obj_id'     => $EVT_ID,
+				'noheader'   => true,
+			],
+			'restore_events'                => [
+				'func'       => '_trash_or_restore_events',
+				'args'       => ['event_status' => 'draft'],
+				'capability' => 'ee_delete_events',
+				'noheader'   => true,
+			],
+			'delete_event'                  => [
+				'func'       => '_delete_event',
+				'capability' => 'ee_delete_event',
+				'obj_id'     => $EVT_ID,
+				'noheader'   => true,
+			],
+			'delete_events'                 => [
+				'func'       => '_delete_events',
+				'capability' => 'ee_delete_events',
+				'noheader'   => true,
+			],
+			'view_report'                   => [
+				'func'       => '_view_report',
+				'capability' => 'ee_edit_events',
+			],
+			'default_event_settings'        => [
+				'func'       => '_default_event_settings',
+				'capability' => 'manage_options',
+			],
+			'update_default_event_settings' => [
+				'func'       => '_update_default_event_settings',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			],
+			'template_settings'             => [
+				'func'       => '_template_settings',
+				'capability' => 'manage_options',
+			],
+			// event category tab related
+			'add_category'                  => [
+				'func'       => '_category_details',
+				'capability' => 'ee_edit_event_category',
+				'args'       => ['add'],
+			],
+			'edit_category'                 => [
+				'func'       => '_category_details',
+				'capability' => 'ee_edit_event_category',
+				'args'       => ['edit'],
+			],
+			'delete_categories'             => [
+				'func'       => '_delete_categories',
+				'capability' => 'ee_delete_event_category',
+				'noheader'   => true,
+			],
+			'delete_category'               => [
+				'func'       => '_delete_categories',
+				'capability' => 'ee_delete_event_category',
+				'noheader'   => true,
+			],
+			'insert_category'               => [
+				'func'       => '_insert_or_update_category',
+				'args'       => ['new_category' => true],
+				'capability' => 'ee_edit_event_category',
+				'noheader'   => true,
+			],
+			'update_category'               => [
+				'func'       => '_insert_or_update_category',
+				'args'       => ['new_category' => false],
+				'capability' => 'ee_edit_event_category',
+				'noheader'   => true,
+			],
+			'category_list'                 => [
+				'func'       => '_category_list_table',
+				'capability' => 'ee_manage_event_categories',
+			],
+			'preview_deletion'              => [
+				'func'       => 'previewDeletion',
+				'capability' => 'ee_delete_events',
+			],
+			'confirm_deletion'              => [
+				'func'       => 'confirmDeletion',
+				'capability' => 'ee_delete_events',
+				'noheader'   => true,
+			],
+		];
+	}
+
+
+	/**
+	 * Set the _page_config property for this admin page group.
+	 */
+	protected function _set_page_config()
+	{
+		$post_id            = $this->request->getRequestParam('post', 0, 'int');
+		$EVT_CAT_ID         = $this->request->getRequestParam('EVT_CAT_ID', 0, 'int');
+		$this->_page_config = [
+			'default'                => [
+				'nav'           => [
+					'label' => esc_html__('Overview', 'event_espresso'),
+					'icon' => 'dashicons-list-view',
+					'order' => 10,
+				],
+				'list_table'    => 'Events_Admin_List_Table',
+				'help_tabs'     => [
+					'events_overview_help_tab'                       => [
+						'title'    => esc_html__('Events Overview', 'event_espresso'),
+						'filename' => 'events_overview',
+					],
+					'events_overview_table_column_headings_help_tab' => [
+						'title'    => esc_html__('Events Overview Table Column Headings', 'event_espresso'),
+						'filename' => 'events_overview_table_column_headings',
+					],
+					'events_overview_filters_help_tab'               => [
+						'title'    => esc_html__('Events Overview Filters', 'event_espresso'),
+						'filename' => 'events_overview_filters',
+					],
+					'events_overview_view_help_tab'                  => [
+						'title'    => esc_html__('Events Overview Views', 'event_espresso'),
+						'filename' => 'events_overview_views',
+					],
+					'events_overview_other_help_tab'                 => [
+						'title'    => esc_html__('Events Overview Other', 'event_espresso'),
+						'filename' => 'events_overview_other',
+					],
+				],
+				'require_nonce' => false,
+			],
+			'create_new'             => [
+				'nav'           => [
+					'label'      => esc_html__('Add New Event', 'event_espresso'),
+					'icon' => 'dashicons-plus-alt',
+					'order'      => 5,
+					'persistent' => false,
+				],
+				'metaboxes'     => ['_register_event_editor_meta_boxes'],
+				'help_tabs'     => [
+					'event_editor_help_tab'                            => [
+						'title'    => esc_html__('Event Editor', 'event_espresso'),
+						'filename' => 'event_editor',
+					],
+					'event_editor_title_richtexteditor_help_tab'       => [
+						'title'    => esc_html__('Event Title & Rich Text Editor', 'event_espresso'),
+						'filename' => 'event_editor_title_richtexteditor',
+					],
+					'event_editor_venue_details_help_tab'              => [
+						'title'    => esc_html__('Event Venue Details', 'event_espresso'),
+						'filename' => 'event_editor_venue_details',
+					],
+					'event_editor_event_datetimes_help_tab'            => [
+						'title'    => esc_html__('Event Datetimes', 'event_espresso'),
+						'filename' => 'event_editor_event_datetimes',
+					],
+					'event_editor_event_tickets_help_tab'              => [
+						'title'    => esc_html__('Event Tickets', 'event_espresso'),
+						'filename' => 'event_editor_event_tickets',
+					],
+					'event_editor_event_registration_options_help_tab' => [
+						'title'    => esc_html__('Event Registration Options', 'event_espresso'),
+						'filename' => 'event_editor_event_registration_options',
+					],
+					'event_editor_tags_categories_help_tab'            => [
+						'title'    => esc_html__('Event Tags & Categories', 'event_espresso'),
+						'filename' => 'event_editor_tags_categories',
+					],
+					'event_editor_questions_registrants_help_tab'      => [
+						'title'    => esc_html__('Questions for Registrants', 'event_espresso'),
+						'filename' => 'event_editor_questions_registrants',
+					],
+					'event_editor_save_new_event_help_tab'             => [
+						'title'    => esc_html__('Save New Event', 'event_espresso'),
+						'filename' => 'event_editor_save_new_event',
+					],
+					'event_editor_other_help_tab'                      => [
+						'title'    => esc_html__('Event Other', 'event_espresso'),
+						'filename' => 'event_editor_other',
+					],
+				],
+				'qtips'         => ['EE_Event_Editor_Decaf_Tips'],
+				'require_nonce' => false,
+			],
+			'edit'                   => [
+				'nav'           => [
+					'label'      => esc_html__('Edit Event', 'event_espresso'),
+					'icon' => 'dashicons-edit',
+					'order'      => 5,
+					'persistent' => false,
+					'url'        => $post_id
+						? EE_Admin_Page::add_query_args_and_nonce(
+							['post' => $post_id, 'action' => 'edit'],
+							$this->_current_page_view_url
+						)
+						: $this->_admin_base_url,
+				],
+				'metaboxes'     => ['_register_event_editor_meta_boxes'],
+				'help_tabs'     => [
+					'event_editor_help_tab'                            => [
+						'title'    => esc_html__('Event Editor', 'event_espresso'),
+						'filename' => 'event_editor',
+					],
+					'event_editor_title_richtexteditor_help_tab'       => [
+						'title'    => esc_html__('Event Title & Rich Text Editor', 'event_espresso'),
+						'filename' => 'event_editor_title_richtexteditor',
+					],
+					'event_editor_venue_details_help_tab'              => [
+						'title'    => esc_html__('Event Venue Details', 'event_espresso'),
+						'filename' => 'event_editor_venue_details',
+					],
+					'event_editor_event_datetimes_help_tab'            => [
+						'title'    => esc_html__('Event Datetimes', 'event_espresso'),
+						'filename' => 'event_editor_event_datetimes',
+					],
+					'event_editor_event_tickets_help_tab'              => [
+						'title'    => esc_html__('Event Tickets', 'event_espresso'),
+						'filename' => 'event_editor_event_tickets',
+					],
+					'event_editor_event_registration_options_help_tab' => [
+						'title'    => esc_html__('Event Registration Options', 'event_espresso'),
+						'filename' => 'event_editor_event_registration_options',
+					],
+					'event_editor_tags_categories_help_tab'            => [
+						'title'    => esc_html__('Event Tags & Categories', 'event_espresso'),
+						'filename' => 'event_editor_tags_categories',
+					],
+					'event_editor_questions_registrants_help_tab'      => [
+						'title'    => esc_html__('Questions for Registrants', 'event_espresso'),
+						'filename' => 'event_editor_questions_registrants',
+					],
+					'event_editor_save_new_event_help_tab'             => [
+						'title'    => esc_html__('Save New Event', 'event_espresso'),
+						'filename' => 'event_editor_save_new_event',
+					],
+					'event_editor_other_help_tab'                      => [
+						'title'    => esc_html__('Event Other', 'event_espresso'),
+						'filename' => 'event_editor_other',
+					],
+				],
+				'require_nonce' => false,
+			],
+			'default_event_settings' => [
+				'nav'           => [
+					'label' => esc_html__('Default Settings', 'event_espresso'),
+					'icon' => 'dashicons-admin-generic',
+					'order' => 40,
+				],
+				'metaboxes'     => array_merge(['_publish_post_box'], $this->_default_espresso_metaboxes),
+				'labels'        => [
+					'publishbox' => esc_html__('Update Settings', 'event_espresso'),
+				],
+				'help_tabs'     => [
+					'default_settings_help_tab'        => [
+						'title'    => esc_html__('Default Event Settings', 'event_espresso'),
+						'filename' => 'events_default_settings',
+					],
+					'default_settings_status_help_tab' => [
+						'title'    => esc_html__('Default Registration Status', 'event_espresso'),
+						'filename' => 'events_default_settings_status',
+					],
+					'default_maximum_tickets_help_tab' => [
+						'title'    => esc_html__('Default Maximum Tickets Per Order', 'event_espresso'),
+						'filename' => 'events_default_settings_max_tickets',
+					],
+				],
+				'require_nonce' => false,
+			],
+			// template settings
+			'template_settings'      => [
+				'nav'           => [
+					'label' => esc_html__( 'Templates', 'event_espresso'),
+					'icon' => 'dashicons-layout',
+					'order' => 30,
+				],
+				'metaboxes'     => $this->_default_espresso_metaboxes,
+				'help_tabs'     => [
+					'general_settings_templates_help_tab' => [
+						'title'    => esc_html__('Templates', 'event_espresso'),
+						'filename' => 'general_settings_templates',
+					],
+				],
+				'require_nonce' => false,
+			],
+			// event category stuff
+			'add_category'           => [
+				'nav'           => [
+					'label'      => esc_html__('Add Category', 'event_espresso'),
+					'icon' => 'dashicons-plus-alt',
+					'order'      => 25,
+					'persistent' => false,
+				],
+				'help_tabs'     => [
+					'add_category_help_tab' => [
+						'title'    => esc_html__('Add New Event Category', 'event_espresso'),
+						'filename' => 'events_add_category',
+					],
+				],
+				'metaboxes'     => ['_publish_post_box'],
+				'require_nonce' => false,
+			],
+			'edit_category'          => [
+				'nav'           => [
+					'label'      => esc_html__('Edit Category', 'event_espresso'),
+					'icon' => 'dashicons-edit',
+					'order'      => 25,
+					'persistent' => false,
+					'url'        => $EVT_CAT_ID
+						? add_query_arg(
+							['EVT_CAT_ID' => $EVT_CAT_ID],
+							$this->_current_page_view_url
+						)
+						: $this->_admin_base_url,
+				],
+				'help_tabs'     => [
+					'edit_category_help_tab' => [
+						'title'    => esc_html__('Edit Event Category', 'event_espresso'),
+						'filename' => 'events_edit_category',
+					],
+				],
+				'metaboxes'     => ['_publish_post_box'],
+				'require_nonce' => false,
+			],
+			'category_list'          => [
+				'nav'           => [
+					'label' => esc_html__('Categories', 'event_espresso'),
+					'icon' => 'dashicons-networking',
+					'order' => 20,
+				],
+				'list_table'    => 'Event_Categories_Admin_List_Table',
+				'help_tabs'     => [
+					'events_categories_help_tab'                       => [
+						'title'    => esc_html__('Event Categories', 'event_espresso'),
+						'filename' => 'events_categories',
+					],
+					'events_categories_table_column_headings_help_tab' => [
+						'title'    => esc_html__('Event Categories Table Column Headings', 'event_espresso'),
+						'filename' => 'events_categories_table_column_headings',
+					],
+					'events_categories_view_help_tab'                  => [
+						'title'    => esc_html__('Event Categories Views', 'event_espresso'),
+						'filename' => 'events_categories_views',
+					],
+					'events_categories_other_help_tab'                 => [
+						'title'    => esc_html__('Event Categories Other', 'event_espresso'),
+						'filename' => 'events_categories_other',
+					],
+				],
+				'metaboxes'     => $this->_default_espresso_metaboxes,
+				'require_nonce' => false,
+			],
+			'preview_deletion'       => [
+				'nav'           => [
+					'label'      => esc_html__('Preview Deletion', 'event_espresso'),
+					'icon' => 'dashicons-remove',
+					'order'      => 15,
+					'persistent' => false,
+					'url'        => '',
+				],
+				'require_nonce' => false,
+			],
+		];
+	}
+
+
+	/**
+	 * Used to register any global screen options if necessary for every route in this admin page group.
+	 */
+	protected function _add_screen_options()
+	{
+	}
+
+
+	/**
+	 * Implementing the screen options for the 'default' route.
+	 *
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _add_screen_options_default()
+	{
+		$this->_per_page_screen_option();
+	}
+
+
+	/**
+	 * Implementing screen options for the category list route.
+	 *
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _add_screen_options_category_list()
+	{
+		$page_title              = $this->_admin_page_title;
+		$this->_admin_page_title = esc_html__('Categories', 'event_espresso');
+		$this->_per_page_screen_option();
+		$this->_admin_page_title = $page_title;
+	}
+
+
+	/**
+	 * Used to register any global feature pointers for the admin page group.
+	 */
+	protected function _add_feature_pointers()
+	{
+	}
+
+
+	/**
+	 * Registers and enqueues any global scripts and styles for the entire admin page group.
+	 */
+	public function load_scripts_styles()
+	{
+		wp_register_style(
+			'events-admin-css',
+			EVENTS_ASSETS_URL . 'events-admin-page.css',
+			[],
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_register_style(
+			'ee-cat-admin',
+			EVENTS_ASSETS_URL . 'ee-cat-admin.css',
+			[],
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('events-admin-css');
+		wp_enqueue_style('ee-cat-admin');
+		// scripts
+		wp_register_script(
+			'event_editor_js',
+			EVENTS_ASSETS_URL . 'event_editor.js',
+			['ee_admin_js', 'jquery-ui-slider', 'jquery-ui-timepicker-addon'],
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+	}
+
+
+	/**
+	 * Enqueuing scripts and styles specific to this view
+	 */
+	public function load_scripts_styles_create_new()
+	{
+		$this->load_scripts_styles_edit();
+	}
+
+
+	/**
+	 * Enqueuing scripts and styles specific to this view
+	 */
+	public function load_scripts_styles_edit()
+	{
+		// styles
+		wp_enqueue_style('espresso-ui-theme');
+		wp_register_style(
+			'event-editor-css',
+			EVENTS_ASSETS_URL . 'event-editor.css',
+			['ee-admin-css'],
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('event-editor-css');
+		// scripts
+		if (! $this->admin_config->useAdvancedEditor()) {
+			wp_register_script(
+				'event-datetime-metabox',
+				EVENTS_ASSETS_URL . 'event-datetime-metabox.js',
+				['event_editor_js', 'ee-datepicker'],
+				EVENT_ESPRESSO_VERSION
+			);
+			wp_enqueue_script('event-datetime-metabox');
+		}
+	}
+
+
+	/**
+	 * Populating the _views property for the category list table view.
+	 */
+	protected function _set_list_table_views_category_list()
+	{
+		$this->_views = [
+			'all' => [
+				'slug'        => 'all',
+				'label'       => esc_html__('All', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => [
+					'delete_categories' => esc_html__('Delete Permanently', 'event_espresso'),
+				],
+			],
+		];
+	}
+
+
+	/**
+	 * For adding anything that fires on the admin_init hook for any route within this admin page group.
+	 */
+	public function admin_init()
+	{
+		EE_Registry::$i18n_js_strings['image_confirm'] = esc_html__(
+			'Do you really want to delete this image? Please remember to update your event to complete the removal.',
+			'event_espresso'
+		);
+	}
+
+
+	/**
+	 * For adding anything that should be triggered on the admin_notices hook for any route within this admin page
+	 * group.
+	 */
+	public function admin_notices()
+	{
+	}
+
+
+	/**
+	 * For adding anything that should be triggered on the `admin_print_footer_scripts` hook for any route within
+	 * this admin page group.
+	 */
+	public function admin_footer_scripts()
+	{
+	}
+
+
+	/**
+	 * Call this function to verify if an event is public and has tickets for sale.  If it does, then we need to show a
+	 * warning (via EE_Error::add_error());
+	 *
+	 * @param EE_Event $event Event object
+	 * @param string   $req_type
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function verify_event_edit($event = null, $req_type = '')
+	{
+		// don't need to do this when processing
+		if (! empty($req_type)) {
+			return;
+		}
+		// no event?
+		if (! $event instanceof EE_Event) {
+			$event = $this->_cpt_model_obj;
+		}
+		// STILL no event?
+		if (! $event instanceof EE_Event) {
+			return;
+		}
+		$orig_status = $event->status();
+		// first check if event is active.
+		if (
+			$orig_status === EEM_Event::cancelled
+			|| $orig_status === EEM_Event::postponed
+			|| $event->is_expired()
+			|| $event->is_inactive()
+		) {
+			return;
+		}
+		// made it here so it IS active... next check that any of the tickets are sold.
+		if ($event->is_sold_out(true)) {
+			if ($orig_status !== EEM_Event::sold_out && $event->status() !== $orig_status) {
+				EE_Error::add_attention(
+					sprintf(
+						esc_html__(
+							'Please note that the Event Status has automatically been changed to %s because there are no more spaces available for this event.  However, this change is not permanent until you update the event.  You can change the status back to something else before updating if you wish.',
+							'event_espresso'
+						),
+						EEH_Template::pretty_status(EEM_Event::sold_out, false, 'sentence')
+					)
+				);
+			}
+			return;
+		}
+		if ($orig_status === EEM_Event::sold_out) {
+			EE_Error::add_attention(
+				sprintf(
+					esc_html__(
+						'Please note that the Event Status has automatically been changed to %s because more spaces have become available for this event, most likely due to abandoned transactions freeing up reserved tickets.  However, this change is not permanent until you update the event. If you wish, you can change the status back to something else before updating.',
+						'event_espresso'
+					),
+					EEH_Template::pretty_status($event->status(), false, 'sentence')
+				)
+			);
+		}
+		// now we need to determine if the event has any tickets on sale.  If not then we dont' show the error
+		if (! $event->tickets_on_sale()) {
+			return;
+		}
+		// made it here so show warning
+		$this->_edit_event_warning();
+	}
+
+
+	/**
+	 * This is the text used for when an event is being edited that is public and has tickets for sale.
+	 * When needed, hook this into a EE_Error::add_error() notice.
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _edit_event_warning()
+	{
+		// we don't want to add warnings during these requests
+		if ($this->request->getRequestParam('action') === 'editpost') {
+			return;
+		}
+		EE_Error::add_attention(
+			sprintf(
+				esc_html__(
+					'Your event is open for registration. Making changes may disrupt any transactions in progress. %sLearn more%s',
+					'event_espresso'
+				),
+				'<a class="espresso-help-tab-lnk ee-help-tab-link">',
+				'</a>'
+			)
+		);
+	}
+
+
+	/**
+	 * When a user is creating a new event, notify them if they haven't set their timezone.
+	 * Otherwise, do the normal logic
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _create_new_cpt_item()
+	{
+		$has_timezone_string = get_option('timezone_string');
+		// only nag them about setting their timezone if it's their first event, and they haven't already done it
+		if (! $has_timezone_string && ! EEM_Event::instance()->exists([])) {
+			EE_Error::add_attention(
+				sprintf(
+					esc_html__(
+						'Your website\'s timezone is currently set to a UTC offset. We recommend updating your timezone to a city or region near you before you create an event. Change your timezone now:%1$s%2$s%3$sChange Timezone%4$s',
+						'event_espresso'
+					),
+					'<br>',
+					'<select id="timezone_string" name="timezone_string" aria-describedby="timezone-description">'
+					. EEH_DTT_Helper::wp_timezone_choice('', EEH_DTT_Helper::get_user_locale())
+					. '</select>',
+					'<button class="button button--secondary timezone-submit">',
+					'</button><span class="spinner"></span>'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		parent::_create_new_cpt_item();
+	}
+
+
+	/**
+	 * Sets the _views property for the default route in this admin page group.
+	 */
+	protected function _set_list_table_views_default()
+	{
+		$this->_views = [
+			'all'   => [
+				'slug'        => 'all',
+				'label'       => esc_html__('View All Events', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => [
+					'trash_events' => esc_html__('Move to Trash', 'event_espresso'),
+				],
+			],
+			'draft' => [
+				'slug'        => 'draft',
+				'label'       => esc_html__('Draft', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => [
+					'trash_events' => esc_html__('Move to Trash', 'event_espresso'),
+				],
+			],
+		];
+		if (EE_Registry::instance()->CAP->current_user_can('ee_delete_events', 'espresso_events_trash_events')) {
+			$this->_views['trash'] = [
+				'slug'        => 'trash',
+				'label'       => esc_html__('Trash', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => [
+					'restore_events' => esc_html__('Restore From Trash', 'event_espresso'),
+					'delete_events'  => esc_html__('Delete Permanently', 'event_espresso'),
+				],
+			];
+		}
+	}
+
+
+	/**
+	 * Provides the legend item array for the default list table view.
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	protected function _event_legend_items()
+	{
+		$items    = [
+			'view_details'   => [
+				'class' => 'dashicons dashicons-visibility',
+				'desc'  => esc_html__('View Event', 'event_espresso'),
+			],
+			'edit_event'     => [
+				'class' => 'dashicons dashicons-calendar-alt',
+				'desc'  => esc_html__('Edit Event Details', 'event_espresso'),
+			],
+			'view_attendees' => [
+				'class' => 'dashicons dashicons-groups',
+				'desc'  => esc_html__('View Registrations for Event', 'event_espresso'),
+			],
+		];
+		$items    = apply_filters('FHEE__Events_Admin_Page___event_legend_items__items', $items);
+		$statuses = [
+			'sold_out_status'  => [
+				'class' => 'ee-status-legend ee-status-bg--' . EE_Datetime::sold_out,
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::sold_out, false, 'sentence'),
+			],
+			'active_status'    => [
+				'class' => 'ee-status-legend ee-status-bg--' . EE_Datetime::active,
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::active, false, 'sentence'),
+			],
+			'upcoming_status'  => [
+				'class' => 'ee-status-legend ee-status-bg--' . EE_Datetime::upcoming,
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::upcoming, false, 'sentence'),
+			],
+			'postponed_status' => [
+				'class' => 'ee-status-legend ee-status-bg--' . EE_Datetime::postponed,
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::postponed, false, 'sentence'),
+			],
+			'cancelled_status' => [
+				'class' => 'ee-status-legend ee-status-bg--' . EE_Datetime::cancelled,
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::cancelled, false, 'sentence'),
+			],
+			'expired_status'   => [
+				'class' => 'ee-status-legend ee-status-bg--' . EE_Datetime::expired,
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::expired, false, 'sentence'),
+			],
+			'inactive_status'  => [
+				'class' => 'ee-status-legend ee-status-bg--' . EE_Datetime::inactive,
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::inactive, false, 'sentence'),
+			],
+		];
+		$statuses = apply_filters('FHEE__Events_Admin_Page__event_legend_items__statuses', $statuses);
+		return array_merge($items, $statuses);
+	}
+
+
+	/**
+	 * @return EEM_Event
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function _event_model()
+	{
+		if (! $this->_event_model instanceof EEM_Event) {
+			$this->_event_model = EE_Registry::instance()->load_model('Event');
+		}
+		return $this->_event_model;
+	}
+
+
+	/**
+	 * Adds extra buttons to the WP CPT permalink field row.
+	 * 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
+	 * @param string $new_title What the title is
+	 * @param string $new_slug  what the slug is
+	 * @return string            The new html string for the permalink area
+	 */
+	public function extra_permalink_field_buttons($return, $id, $new_title, $new_slug)
+	{
+		// make sure this is only when editing
+		if (! empty($id)) {
+			$post = get_post($id);
+			$return .= '<a class="button button--small button--secondary" onclick="prompt(\'Shortcode:\', jQuery(\'#shortcode\').val()); return false;" href="#"  tabindex="-1">'
+					   . esc_html__('Shortcode', 'event_espresso')
+					   . '</a> ';
+			$return .= '<input id="shortcode" type="hidden" value="[ESPRESSO_TICKET_SELECTOR event_id='
+					   . $post->ID
+					   . ']">';
+		}
+		return $return;
+	}
+
+
+	/**
+	 * _events_overview_list_table
+	 * This contains the logic for showing the events_overview list
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _events_overview_list_table()
+	{
+		$after_list_table                           = [];
+		$links_html = EEH_HTML::div('', '', 'ee-admin-section ee-layout-stack');
+		$links_html .= EEH_HTML::h3(esc_html__('Links', 'event_espresso'));
+		$links_html .= EEH_HTML::div(
+			EEH_Template::get_button_or_link(
+				get_post_type_archive_link('espresso_events'),
+				esc_html__('View Event Archive Page', 'event_espresso'),
+				'button button--small button--secondary'
+			),
+			'',
+			'ee-admin-button-row ee-admin-button-row--align-start'
+		);
+		$links_html .= EEH_HTML::divx();
+
+		$after_list_table['view_event_list_button'] = $links_html;
+
+		$after_list_table['legend'] = $this->_display_legend($this->_event_legend_items());
+		$this->_admin_page_title                    .= ' ' . $this->get_action_link_or_button(
+			'create_new',
+			'add',
+			[],
+			'add-new-h2'
+		);
+
+		$this->_template_args['after_list_table']   = array_merge(
+			(array) $this->_template_args['after_list_table'],
+			$after_list_table
+		);
+		$this->display_admin_list_table_page_with_no_sidebar();
+	}
+
+
+	/**
+	 * this allows for extra misc actions in the default WP publish box
+	 *
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function extra_misc_actions_publish_box()
+	{
+		$this->_generate_publish_box_extra_content();
+	}
+
+
+	/**
+	 * This is hooked into the WordPress do_action('save_post') hook and runs after the custom post type has been
+	 * saved.
+	 * 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.
+	 *
+	 * @access protected
+	 * @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
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _insert_update_cpt_item($post_id, $post)
+	{
+		if ($post instanceof WP_Post && $post->post_type !== 'espresso_events') {
+			// get out we're not processing an event save.
+			return;
+		}
+		$event_values = [
+			'EVT_member_only'     => $this->request->getRequestParam('member_only', false, 'bool'),
+			'EVT_allow_overflow'  => $this->request->getRequestParam('EVT_allow_overflow', false, 'bool'),
+			'EVT_timezone_string' => $this->request->getRequestParam('timezone_string'),
+		];
+		// check if the new EDTR reg options meta box is being used, and if so, don't run updates for legacy version
+		if (! $this->admin_config->useAdvancedEditor() || ! $this->feature->allowed('use_reg_options_meta_box')) {
+			$event_values['EVT_display_ticket_selector']     = $this->request->getRequestParam(
+				'display_ticket_selector',
+				false,
+				'bool'
+			);
+			$event_values['EVT_additional_limit']            = min(
+				apply_filters('FHEE__EE_Events_Admin__insert_update_cpt_item__EVT_additional_limit_max', 255),
+				$this->request->getRequestParam('additional_limit', null, 'int')
+			);
+			$event_values['EVT_default_registration_status'] = $this->request->getRequestParam(
+				'EVT_default_registration_status',
+				EE_Registry::instance()->CFG->registration->default_STS_ID
+			);
+
+			$event_values['EVT_external_URL'] = $this->request->getRequestParam('externalURL');
+			$event_values['EVT_phone']        = $this->request->getRequestParam('event_phone');
+			$event_values['EVT_display_desc'] = $this->request->getRequestParam('display_desc', false, 'bool');
+		}
+		// update event
+		$success = $this->_event_model()->update_by_ID($event_values, $post_id);
+		// get event_object for other metaboxes...
+		// though it would seem to make sense to just use $this->_event_model()->get_one_by_ID( $post_id )..
+		// i have to setup where conditions to override the filters in the model
+		// that filter out autodraft and inherit statuses so we GET the inherit id!
+		$event = $this->_event_model()->get_one(
+			[
+				[
+					$this->_event_model()->primary_key_name() => $post_id,
+					'OR'                                      => [
+						'status'   => $post->post_status,
+						// if trying to "Publish" a sold out event, it's status will get switched back to "sold_out" in the db,
+						// but the returned object here has a status of "publish", so use the original post status as well
+						'status*1' => $this->request->getRequestParam('original_post_status'),
+					],
+				],
+			]
+		);
+
+		// the following are default callbacks for event attachment updates
+		// that can be overridden by caffeinated functionality and/or addons.
+		$event_update_callbacks = [];
+		if (! $this->admin_config->useAdvancedEditor()) {
+			$event_update_callbacks['_default_venue_update']   = [$this, '_default_venue_update'];
+			$event_update_callbacks['_default_tickets_update'] = [$this, '_default_tickets_update'];
+		}
+		$event_update_callbacks = apply_filters(
+			'FHEE__Events_Admin_Page___insert_update_cpt_item__event_update_callbacks',
+			$event_update_callbacks
+		);
+
+		$att_success = true;
+		foreach ($event_update_callbacks as $e_callback) {
+			$_success = is_callable($e_callback)
+				? $e_callback($event, $this->request->requestParams())
+				: false;
+			// if ANY of these updates fail then we want the appropriate global error message
+			$att_success = $_success !== false ? $att_success : false;
+		}
+		// any errors?
+		if ($success && $att_success === false) {
+			EE_Error::add_error(
+				esc_html__(
+					'Event Details saved successfully but something went wrong with saving attachments.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		} elseif ($success === false) {
+			EE_Error::add_error(
+				esc_html__('Event Details did not save successfully.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+	}
+
+
+	/**
+	 * @param int $post_id
+	 * @param int $revision_id
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @see parent::restore_item()
+	 */
+	protected function _restore_cpt_item($post_id, $revision_id)
+	{
+		// copy existing event meta to new post
+		$post_evt = $this->_event_model()->get_one_by_ID($post_id);
+		if ($post_evt instanceof EE_Event) {
+			// meta revision restore
+			$post_evt->restore_revision($revision_id);
+			// related objs restore
+			$post_evt->restore_revision($revision_id, ['Venue', 'Datetime', 'Price']);
+		}
+	}
+
+
+	/**
+	 * Attach the venue to the Event
+	 *
+	 * @param EE_Event $event Event Object to add the venue to
+	 * @param array    $data  The request data from the form
+	 * @return bool           Success or fail.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _default_venue_update(EE_Event $event, $data)
+	{
+		require_once(EE_MODELS . 'EEM_Venue.model.php');
+		$venue_model = EE_Registry::instance()->load_model('Venue');
+		$venue_id    = ! empty($data['venue_id']) ? $data['venue_id'] : null;
+		// very important.  If we don't have a venue name...
+		// then we'll get out because not necessary to create empty venue
+		if (empty($data['venue_title'])) {
+			return false;
+		}
+		$venue_array = [
+			'VNU_wp_user'         => $event->get('EVT_wp_user'),
+			'VNU_name'            => ! empty($data['venue_title']) ? $data['venue_title'] : null,
+			'VNU_desc'            => ! empty($data['venue_description']) ? $data['venue_description'] : null,
+			'VNU_identifier'      => ! empty($data['venue_identifier']) ? $data['venue_identifier'] : null,
+			'VNU_short_desc'      => ! empty($data['venue_short_description'])
+				? $data['venue_short_description']
+				: null,
+			'VNU_address'         => ! empty($data['address']) ? $data['address'] : null,
+			'VNU_address2'        => ! empty($data['address2']) ? $data['address2'] : null,
+			'VNU_city'            => ! empty($data['city']) ? $data['city'] : null,
+			'STA_ID'              => ! empty($data['state']) ? $data['state'] : null,
+			'CNT_ISO'             => ! empty($data['countries']) ? $data['countries'] : null,
+			'VNU_zip'             => ! empty($data['zip']) ? $data['zip'] : null,
+			'VNU_phone'           => ! empty($data['venue_phone']) ? $data['venue_phone'] : null,
+			'VNU_capacity'        => ! empty($data['venue_capacity']) ? $data['venue_capacity'] : null,
+			'VNU_url'             => ! empty($data['venue_url']) ? $data['venue_url'] : null,
+			'VNU_virtual_phone'   => ! empty($data['virtual_phone']) ? $data['virtual_phone'] : null,
+			'VNU_virtual_url'     => ! empty($data['virtual_url']) ? $data['virtual_url'] : null,
+			'VNU_enable_for_gmap' => isset($data['enable_for_gmap']) ? 1 : 0,
+			'status'              => 'publish',
+		];
+		// if we've got the venue_id then we're just updating the existing venue so let's do that and then get out.
+		if (! empty($venue_id)) {
+			$update_where  = [$venue_model->primary_key_name() => $venue_id];
+			$rows_affected = $venue_model->update($venue_array, [$update_where]);
+			// we've gotta make sure that the venue is always attached to a revision..
+			// add_relation_to should take care of making sure that the relation is already present.
+			$event->_add_relation_to($venue_id, 'Venue');
+			return $rows_affected > 0;
+		}
+		// we insert the venue
+		$venue_id = $venue_model->insert($venue_array);
+		$event->_add_relation_to($venue_id, 'Venue');
+		return ! empty($venue_id);
+		// when we have the ancestor come in it's already been handled by the revision save.
+	}
+
+
+	/**
+	 * Handles saving everything related to Tickets (datetimes, tickets, prices)
+	 *
+	 * @param EE_Event $event The Event object we're attaching data to
+	 * @param array    $data  The request data from the form
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws Exception
+	 */
+	protected function _default_tickets_update(EE_Event $event, $data)
+	{
+		if ($this->admin_config->useAdvancedEditor()) {
+			return [];
+		}
+		$datetime       = null;
+		$saved_tickets  = [];
+		$event_timezone = $event->get_timezone();
+		$date_formats   = ['Y-m-d', 'h:i a'];
+		foreach ($data['edit_event_datetimes'] as $row => $datetime_data) {
+			// trim all values to ensure any excess whitespace is removed.
+			$datetime_data                = array_map('trim', $datetime_data);
+			$datetime_data['DTT_EVT_end'] =
+				isset($datetime_data['DTT_EVT_end']) && ! empty($datetime_data['DTT_EVT_end'])
+					? $datetime_data['DTT_EVT_end']
+					: $datetime_data['DTT_EVT_start'];
+			$datetime_values              = [
+				'DTT_ID'        => ! empty($datetime_data['DTT_ID']) ? $datetime_data['DTT_ID'] : null,
+				'DTT_EVT_start' => $datetime_data['DTT_EVT_start'],
+				'DTT_EVT_end'   => $datetime_data['DTT_EVT_end'],
+				'DTT_reg_limit' => empty($datetime_data['DTT_reg_limit']) ? EE_INF : $datetime_data['DTT_reg_limit'],
+				'DTT_order'     => $row,
+			];
+			// if we have an id then let's get existing object first and then set the new values.
+			//  Otherwise we instantiate a new object for save.
+			if (! empty($datetime_data['DTT_ID'])) {
+				$datetime = EEM_Datetime::instance($event_timezone)->get_one_by_ID($datetime_data['DTT_ID']);
+				if (! $datetime instanceof EE_Datetime) {
+					throw new RuntimeException(
+						sprintf(
+							esc_html__(
+								'Something went wrong! A valid Datetime could not be retrieved from the database using the supplied ID: %1$d',
+								'event_espresso'
+							),
+							$datetime_data['DTT_ID']
+						)
+					);
+				}
+				$datetime->set_date_format($date_formats[0]);
+				$datetime->set_time_format($date_formats[1]);
+				foreach ($datetime_values as $field => $value) {
+					$datetime->set($field, $value);
+				}
+			} else {
+				$datetime = EE_Datetime::new_instance($datetime_values, $event_timezone, $date_formats);
+			}
+			if (! $datetime instanceof EE_Datetime) {
+				throw new RuntimeException(
+					sprintf(
+						esc_html__(
+							'Something went wrong! A valid Datetime could not be generated or retrieved using the supplied data: %1$s',
+							'event_espresso'
+						),
+						print_r($datetime_values, true)
+					)
+				);
+			}
+			// before going any further make sure our dates are setup correctly
+			// so that the end date is always equal or greater than the start date.
+			if ($datetime->get_raw('DTT_EVT_start') > $datetime->get_raw('DTT_EVT_end')) {
+				$datetime->set('DTT_EVT_end', $datetime->get('DTT_EVT_start'));
+				$datetime = EEH_DTT_Helper::date_time_add($datetime, 'DTT_EVT_end', 'days');
+			}
+			$datetime->save();
+			$event->_add_relation_to($datetime, 'Datetime');
+		}
+		// no datetimes get deleted so we don't do any of that logic here.
+		// update tickets next
+		$old_tickets = isset($data['ticket_IDs']) ? explode(',', $data['ticket_IDs']) : [];
+
+		// set up some default start and end dates in case those are not present in the incoming data
+		$default_start_date = new DateTime('now', new DateTimeZone($event->get_timezone()));
+		$default_start_date = $default_start_date->format($date_formats[0] . ' ' . $date_formats[1]);
+		// use the start date of the first datetime for the end date
+		$first_datetime   = $event->first_datetime();
+		$default_end_date = $first_datetime->start_date_and_time($date_formats[0], $date_formats[1]);
+
+		// now process the incoming data
+		foreach ($data['edit_tickets'] as $row => $ticket_data) {
+			$update_prices = false;
+			$ticket_price  = isset($data['edit_prices'][ $row ][1]['PRC_amount'])
+				? $data['edit_prices'][ $row ][1]['PRC_amount']
+				: 0;
+			// trim inputs to ensure any excess whitespace is removed.
+			$ticket_data   = array_map('trim', $ticket_data);
+			$ticket_values = [
+				'TKT_ID'          => ! empty($ticket_data['TKT_ID']) ? $ticket_data['TKT_ID'] : null,
+				'TTM_ID'          => ! empty($ticket_data['TTM_ID']) ? $ticket_data['TTM_ID'] : 0,
+				'TKT_name'        => ! empty($ticket_data['TKT_name']) ? $ticket_data['TKT_name'] : '',
+				'TKT_description' => ! empty($ticket_data['TKT_description']) ? $ticket_data['TKT_description'] : '',
+				'TKT_start_date'  => ! empty($ticket_data['TKT_start_date'])
+					? $ticket_data['TKT_start_date']
+					: $default_start_date,
+				'TKT_end_date'    => ! empty($ticket_data['TKT_end_date'])
+					? $ticket_data['TKT_end_date']
+					: $default_end_date,
+				'TKT_qty'         => ! empty($ticket_data['TKT_qty'])
+									 || (isset($ticket_data['TKT_qty']) && (int) $ticket_data['TKT_qty'] === 0)
+					? $ticket_data['TKT_qty']
+					: EE_INF,
+				'TKT_uses'        => ! empty($ticket_data['TKT_uses'])
+									 || (isset($ticket_data['TKT_uses']) && (int) $ticket_data['TKT_uses'] === 0)
+					? $ticket_data['TKT_uses']
+					: EE_INF,
+				'TKT_min'         => ! empty($ticket_data['TKT_min']) ? $ticket_data['TKT_min'] : 0,
+				'TKT_max'         => ! empty($ticket_data['TKT_max']) ? $ticket_data['TKT_max'] : EE_INF,
+				'TKT_order'       => isset($ticket_data['TKT_order']) ? $ticket_data['TKT_order'] : $row,
+				'TKT_price'       => $ticket_price,
+				'TKT_row'         => $row,
+			];
+			// if this is a default ticket, then we need to set the TKT_ID to 0 and update accordingly,
+			// which means in turn that the prices will become new prices as well.
+			if (isset($ticket_data['TKT_is_default']) && $ticket_data['TKT_is_default']) {
+				$ticket_values['TKT_ID']         = 0;
+				$ticket_values['TKT_is_default'] = 0;
+				$update_prices                   = true;
+			}
+			// if we have a TKT_ID then we need to get that existing TKT_obj and update it
+			// we actually do our saves ahead of adding any relations because its entirely possible that this
+			// ticket didn't get removed or added to any datetime in the session but DID have it's items modified.
+			// keep in mind that if the ticket has been sold (and we have changed pricing information),
+			// then we won't be updating the tkt but instead a new tkt will be created and the old one archived.
+			if (! empty($ticket_data['TKT_ID'])) {
+				$existing_ticket = EEM_Ticket::instance($event_timezone)->get_one_by_ID($ticket_data['TKT_ID']);
+				if (! $existing_ticket instanceof EE_Ticket) {
+					throw new RuntimeException(
+						sprintf(
+							esc_html__(
+								'Something went wrong! A valid Ticket could not be retrieved from the database using the supplied ID: %1$d',
+								'event_espresso'
+							),
+							$ticket_data['TKT_ID']
+						)
+					);
+				}
+				$ticket_sold = $existing_ticket->count_related(
+					'Registration',
+					[
+							[
+								'STS_ID' => [
+									'NOT IN',
+									[EEM_Registration::status_id_incomplete],
+								],
+							],
+						]
+				) > 0;
+				// let's just check the total price for the existing ticket and determine if it matches the new total price.
+				// if they are different then we create a new ticket (if $ticket_sold)
+				// if they aren't different then we go ahead and modify existing ticket.
+				$create_new_ticket = $ticket_sold
+									 && $ticket_price !== $existing_ticket->price()
+									 && ! $existing_ticket->deleted();
+				$existing_ticket->set_date_format($date_formats[0]);
+				$existing_ticket->set_time_format($date_formats[1]);
+				// set new values
+				foreach ($ticket_values as $field => $value) {
+					if ($field == 'TKT_qty') {
+						$existing_ticket->set_qty($value);
+					} elseif ($field == 'TKT_price') {
+						$existing_ticket->set('TKT_price', $ticket_price);
+					} else {
+						$existing_ticket->set($field, $value);
+					}
+				}
+				$ticket = $existing_ticket;
+				// if $create_new_ticket is false then we can safely update the existing ticket.
+				//  Otherwise we have to create a new ticket.
+				if ($create_new_ticket) {
+					// archive the old ticket first
+					$existing_ticket->set('TKT_deleted', 1);
+					$existing_ticket->save();
+					// make sure this ticket is still recorded in our $saved_tickets
+					// so we don't run it through the regular trash routine.
+					$saved_tickets[ $existing_ticket->ID() ] = $existing_ticket;
+					// create new ticket that's a copy of the existing except,
+					// (a new id of course and not archived) AND has the new TKT_price associated with it.
+					$new_ticket = clone $existing_ticket;
+					$new_ticket->set('TKT_ID', 0);
+					$new_ticket->set('TKT_deleted', 0);
+					$new_ticket->set('TKT_sold', 0);
+					// now we need to make sure that $new prices are created as well and attached to new ticket.
+					$update_prices = true;
+					$ticket        = $new_ticket;
+				}
+			} else {
+				// no TKT_id so a new ticket
+				$ticket_values['TKT_price'] = $ticket_price;
+				$ticket                     = EE_Ticket::new_instance($ticket_values, $event_timezone, $date_formats);
+				$update_prices              = true;
+			}
+			if (! $ticket instanceof EE_Ticket) {
+				throw new RuntimeException(
+					sprintf(
+						esc_html__(
+							'Something went wrong! A valid Ticket could not be generated or retrieved using the supplied data: %1$s',
+							'event_espresso'
+						),
+						print_r($ticket_values, true)
+					)
+				);
+			}
+			// cap ticket qty by datetime reg limits
+			$ticket->set_qty(min($ticket->qty(), $ticket->qty('reg_limit')));
+			// update ticket.
+			$ticket->save();
+			// before going any further make sure our dates are setup correctly
+			// so that the end date is always equal or greater than the start date.
+			if ($ticket->get_raw('TKT_start_date') > $ticket->get_raw('TKT_end_date')) {
+				$ticket->set('TKT_end_date', $ticket->get('TKT_start_date'));
+				$ticket = EEH_DTT_Helper::date_time_add($ticket, 'TKT_end_date', 'days');
+				$ticket->save();
+			}
+			// initially let's add the ticket to the datetime
+			$datetime->_add_relation_to($ticket, 'Ticket');
+			$saved_tickets[ $ticket->ID() ] = $ticket;
+			// add prices to ticket
+			$prices_data = isset($data['edit_prices'][ $row ]) && is_array($data['edit_prices'][ $row ])
+				? $data['edit_prices'][ $row ]
+				: [];
+			$this->_add_prices_to_ticket($prices_data, $ticket, $update_prices);
+		}
+		// however now we need to handle permanently deleting tickets via the ui.
+		// Keep in mind that the ui does not allow deleting/archiving tickets that have ticket sold.
+		// However, it does allow for deleting tickets that have no tickets sold,
+		// in which case we want to get rid of permanently because there is no need to save in db.
+		$old_tickets     = isset($old_tickets[0]) && $old_tickets[0] === '' ? [] : $old_tickets;
+		$tickets_removed = array_diff($old_tickets, array_keys($saved_tickets));
+		foreach ($tickets_removed as $id) {
+			$id = absint($id);
+			// get the ticket for this id
+			$ticket_to_remove = EEM_Ticket::instance()->get_one_by_ID($id);
+			if (! $ticket_to_remove instanceof EE_Ticket) {
+				continue;
+			}
+			// need to get all the related datetimes on this ticket and remove from every single one of them
+			// (remember this process can ONLY kick off if there are NO tickets sold)
+			$related_datetimes = $ticket_to_remove->get_many_related('Datetime');
+			foreach ($related_datetimes as $related_datetime) {
+				$ticket_to_remove->_remove_relation_to($related_datetime, 'Datetime');
+			}
+			// need to do the same for prices (except these prices can also be deleted because again,
+			// tickets can only be trashed if they don't have any TKTs sold (otherwise they are just archived))
+			$ticket_to_remove->delete_related_permanently('Price');
+			// finally let's delete this ticket
+			// (which should not be blocked at this point b/c we've removed all our relationships)
+			$ticket_to_remove->delete_permanently();
+		}
+		return [$datetime, $saved_tickets];
+	}
+
+
+	/**
+	 * This attaches a list of given prices to a ticket.
+	 * Note we dont' have to worry about ever removing relationships (or archiving prices)
+	 * because if there is a change in price information on a ticket, a new ticket is created anyways
+	 * so the archived ticket will retain the old price info and prices are automatically "archived" via the ticket.
+	 *
+	 * @access  private
+	 * @param array     $prices_data Array of prices from the form.
+	 * @param EE_Ticket $ticket      EE_Ticket object that prices are being attached to.
+	 * @param bool      $new_prices  Whether attach existing incoming prices or create new ones.
+	 * @return  void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _add_prices_to_ticket($prices_data, EE_Ticket $ticket, $new_prices = false)
+	{
+		$timezone = $ticket->get_timezone();
+		foreach ($prices_data as $row => $price_data) {
+			$price_values = [
+				'PRC_ID'         => ! empty($price_data['PRC_ID']) ? $price_data['PRC_ID'] : null,
+				'PRT_ID'         => ! empty($price_data['PRT_ID']) ? $price_data['PRT_ID'] : null,
+				'PRC_amount'     => ! empty($price_data['PRC_amount']) ? $price_data['PRC_amount'] : 0,
+				'PRC_name'       => ! empty($price_data['PRC_name']) ? $price_data['PRC_name'] : '',
+				'PRC_desc'       => ! empty($price_data['PRC_desc']) ? $price_data['PRC_desc'] : '',
+				'PRC_is_default' => 0, // make sure prices are NOT set as default from this context
+				'PRC_order'      => $row,
+			];
+			if ($new_prices || empty($price_values['PRC_ID'])) {
+				$price_values['PRC_ID'] = 0;
+				$price                  = EE_Price::new_instance($price_values, $timezone);
+			} else {
+				$price = EEM_Price::instance($timezone)->get_one_by_ID($price_data['PRC_ID']);
+				// update this price with new values
+				foreach ($price_values as $field => $new_price) {
+					$price->set($field, $new_price);
+				}
+			}
+			if (! $price instanceof EE_Price) {
+				throw new RuntimeException(
+					sprintf(
+						esc_html__(
+							'Something went wrong! A valid Price could not be generated or retrieved using the supplied data: %1$s',
+							'event_espresso'
+						),
+						print_r($price_values, true)
+					)
+				);
+			}
+			$price->save();
+			$ticket->_add_relation_to($price, 'Price');
+		}
+	}
+
+
+	/**
+	 * Add in our autosave ajax handlers
+	 *
+	 */
+	protected function _ee_autosave_create_new()
+	{
+	}
+
+
+	/**
+	 * More autosave handlers.
+	 */
+	protected function _ee_autosave_edit()
+	{
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _generate_publish_box_extra_content()
+	{
+		// load formatter helper
+		// args for getting related registrations
+		$approved_query_args        = [
+			[
+				'REG_deleted' => 0,
+				'STS_ID'      => EEM_Registration::status_id_approved,
+			],
+		];
+		$not_approved_query_args    = [
+			[
+				'REG_deleted' => 0,
+				'STS_ID'      => EEM_Registration::status_id_not_approved,
+			],
+		];
+		$pending_payment_query_args = [
+			[
+				'REG_deleted' => 0,
+				'STS_ID'      => EEM_Registration::status_id_pending_payment,
+			],
+		];
+		// publish box
+		$publish_box_extra_args = [
+			'view_approved_reg_url'        => add_query_arg(
+				[
+					'action'      => 'default',
+					'event_id'    => $this->_cpt_model_obj->ID(),
+					'_reg_status' => EEM_Registration::status_id_approved,
+				],
+				REG_ADMIN_URL
+			),
+			'view_not_approved_reg_url'    => add_query_arg(
+				[
+					'action'      => 'default',
+					'event_id'    => $this->_cpt_model_obj->ID(),
+					'_reg_status' => EEM_Registration::status_id_not_approved,
+				],
+				REG_ADMIN_URL
+			),
+			'view_pending_payment_reg_url' => add_query_arg(
+				[
+					'action'      => 'default',
+					'event_id'    => $this->_cpt_model_obj->ID(),
+					'_reg_status' => EEM_Registration::status_id_pending_payment,
+				],
+				REG_ADMIN_URL
+			),
+			'approved_regs'                => $this->_cpt_model_obj->count_related(
+				'Registration',
+				$approved_query_args
+			),
+			'not_approved_regs'            => $this->_cpt_model_obj->count_related(
+				'Registration',
+				$not_approved_query_args
+			),
+			'pending_payment_regs'         => $this->_cpt_model_obj->count_related(
+				'Registration',
+				$pending_payment_query_args
+			),
+			'misc_pub_section_class'       => apply_filters(
+				'FHEE_Events_Admin_Page___generate_publish_box_extra_content__misc_pub_section_class',
+				'misc-pub-section'
+			),
+		];
+		ob_start();
+		do_action(
+			'AHEE__Events_Admin_Page___generate_publish_box_extra_content__event_editor_overview_add',
+			$this->_cpt_model_obj
+		);
+		$publish_box_extra_args['event_editor_overview_add'] = ob_get_clean();
+		// load template
+		EEH_Template::display_template(
+			EVENTS_TEMPLATE_PATH . 'event_publish_box_extras.template.php',
+			$publish_box_extra_args
+		);
+	}
+
+
+	/**
+	 * @return EE_Event
+	 */
+	public function get_event_object()
+	{
+		return $this->_cpt_model_obj;
+	}
+
+
+
+
+	/** METABOXES * */
+	/**
+	 * _register_event_editor_meta_boxes
+	 * add all metaboxes related to the event_editor
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _register_event_editor_meta_boxes()
+	{
+		$this->verify_cpt_object();
+		$use_advanced_editor = $this->admin_config->useAdvancedEditor();
+		// check if the new EDTR reg options meta box is being used, and if so, don't load the legacy version
+		if (! $use_advanced_editor || ! $this->feature->allowed('use_reg_options_meta_box')) {
+			$this->addMetaBox(
+				'espresso_event_editor_event_options',
+				esc_html__('Event Registration Options', 'event_espresso'),
+				[$this, 'registration_options_meta_box'],
+				$this->page_slug,
+				'side'
+			);
+		}
+		if (! $use_advanced_editor) {
+			$this->addMetaBox(
+				'espresso_event_editor_tickets',
+				esc_html__('Event Datetime & Ticket', 'event_espresso'),
+				[$this, 'ticket_metabox'],
+				$this->page_slug,
+				'normal',
+				'high'
+			);
+		} elseif ($this->feature->allowed('use_reg_options_meta_box')) {
+			add_action(
+				'add_meta_boxes_espresso_events',
+				function () {
+					global $current_screen;
+					remove_meta_box('authordiv', $current_screen, 'normal');
+				},
+				99
+			);
+		}
+		// NOTE: if you're looking for other metaboxes in here,
+		// where a metabox has a related management page in the admin
+		// you will find it setup in the related management page's "_Hooks" file.
+		// i.e. messages metabox is found in "espresso_events_Messages_Hooks.class.php".
+	}
+
+
+	/**
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function ticket_metabox()
+	{
+		$existing_datetime_ids = $existing_ticket_ids = [];
+		// defaults for template args
+		$template_args = [
+			'existing_datetime_ids'    => '',
+			'event_datetime_help_link' => '',
+			'ticket_options_help_link' => '',
+			'time'                     => null,
+			'ticket_rows'              => '',
+			'existing_ticket_ids'      => '',
+			'total_ticket_rows'        => 1,
+			'ticket_js_structure'      => '',
+			'trash_icon'               => 'dashicons dashicons-lock',
+			'disabled'                 => '',
+		];
+		$event_id      = is_object($this->_cpt_model_obj) ? $this->_cpt_model_obj->ID() : null;
+		/**
+		 * 1. Start with retrieving Datetimes
+		 * 2. Fore each datetime get related tickets
+		 * 3. For each ticket get related prices
+		 */
+		/** @var EEM_Datetime $datetime_model */
+		$datetime_model = EE_Registry::instance()->load_model('Datetime');
+		/** @var EEM_Ticket $datetime_model */
+		$ticket_model = EE_Registry::instance()->load_model('Ticket');
+		$times        = $datetime_model->get_all_event_dates($event_id);
+		/** @type EE_Datetime $first_datetime */
+		$first_datetime = reset($times);
+		// do we get related tickets?
+		if (
+			$first_datetime instanceof EE_Datetime
+			&& $first_datetime->ID() !== 0
+		) {
+			$existing_datetime_ids[] = $first_datetime->get('DTT_ID');
+			$template_args['time']   = $first_datetime;
+			$related_tickets         = $first_datetime->tickets(
+				[
+					['OR' => ['TKT_deleted' => 1, 'TKT_deleted*' => 0]],
+					'default_where_conditions' => 'none',
+				]
+			);
+			if (! empty($related_tickets)) {
+				$template_args['total_ticket_rows'] = count($related_tickets);
+				$row                                = 0;
+				foreach ($related_tickets as $ticket) {
+					$existing_ticket_ids[]        = $ticket->get('TKT_ID');
+					$template_args['ticket_rows'] .= $this->_get_ticket_row($ticket, false, $row);
+					$row++;
+				}
+			} else {
+				$template_args['total_ticket_rows'] = 1;
+				/** @type EE_Ticket $ticket */
+				$ticket                       = $ticket_model->create_default_object();
+				$template_args['ticket_rows'] .= $this->_get_ticket_row($ticket);
+			}
+		} else {
+			$template_args['time'] = $times[0];
+			/** @type EE_Ticket[] $tickets */
+			$tickets                      = $ticket_model->get_all_default_tickets();
+			$template_args['ticket_rows'] .= $this->_get_ticket_row($tickets[1]);
+			// NOTE: we're just sending the first default row
+			// (decaf can't manage default tickets so this should be sufficient);
+		}
+		$template_args['event_datetime_help_link'] = $this->_get_help_tab_link(
+			'event_editor_event_datetimes_help_tab'
+		);
+		$template_args['ticket_options_help_link'] = $this->_get_help_tab_link('ticket_options_info');
+		$template_args['existing_datetime_ids']    = implode(',', $existing_datetime_ids);
+		$template_args['existing_ticket_ids']      = implode(',', $existing_ticket_ids);
+		$template_args['ticket_js_structure']      = $this->_get_ticket_row(
+			$ticket_model->create_default_object(),
+			true
+		);
+		$template                                  = apply_filters(
+			'FHEE__Events_Admin_Page__ticket_metabox__template',
+			EVENTS_TEMPLATE_PATH . 'event_tickets_metabox_main.template.php'
+		);
+		EEH_Template::display_template($template, $template_args);
+	}
+
+
+	/**
+	 * Setup an individual ticket form for the decaf event editor page
+	 *
+	 * @access private
+	 * @param EE_Ticket $ticket   the ticket object
+	 * @param boolean   $skeleton whether we're generating a skeleton for js manipulation
+	 * @param int       $row
+	 * @return string generated html for the ticket row.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _get_ticket_row($ticket, $skeleton = false, $row = 0)
+	{
+		$template_args = [
+			'tkt_status_class'    => ' tkt-status-' . $ticket->ticket_status(),
+			'tkt_archive_class'   => $ticket->ticket_status() === EE_Ticket::archived && ! $skeleton ? ' tkt-archived'
+				: '',
+			'ticketrow'           => $skeleton ? 'TICKETNUM' : $row,
+			'TKT_ID'              => $ticket->get('TKT_ID'),
+			'TKT_name'            => $ticket->get('TKT_name'),
+			'TKT_start_date'      => $skeleton ? '' : $ticket->get_date('TKT_start_date', 'Y-m-d h:i a'),
+			'TKT_end_date'        => $skeleton ? '' : $ticket->get_date('TKT_end_date', 'Y-m-d h:i a'),
+			'TKT_is_default'      => $ticket->get('TKT_is_default'),
+			'TKT_qty'             => $ticket->get_pretty('TKT_qty', 'input'),
+			'edit_ticketrow_name' => $skeleton ? 'TICKETNAMEATTR' : 'edit_tickets',
+			'TKT_sold'            => $skeleton ? 0 : $ticket->get('TKT_sold'),
+			'trash_icon'          => ($skeleton || (! empty($ticket) && ! $ticket->get('TKT_deleted')))
+									 && (! empty($ticket) && $ticket->get('TKT_sold') === 0)
+				? 'trash-icon dashicons dashicons-post-trash clickable' : 'dashicons dashicons-lock',
+			'disabled'            => $skeleton || (! empty($ticket) && ! $ticket->get('TKT_deleted')) ? ''
+				: ' disabled=disabled',
+		];
+		$price         = $ticket->ID() !== 0
+			? $ticket->get_first_related('Price', ['default_where_conditions' => 'none'])
+			: null;
+		$price         = $price instanceof EE_Price
+			? $price
+			: EEM_Price::instance()->create_default_object();
+		$price_args    = [
+			'price_currency_symbol' => EE_Registry::instance()->CFG->currency->sign,
+			'PRC_amount'            => $price->get('PRC_amount'),
+			'PRT_ID'                => $price->get('PRT_ID'),
+			'PRC_ID'                => $price->get('PRC_ID'),
+			'PRC_is_default'        => $price->get('PRC_is_default'),
+		];
+		// make sure we have default start and end dates if skeleton
+		// handle rows that should NOT be empty
+		if (empty($template_args['TKT_start_date'])) {
+			// if empty then the start date will be now.
+			$template_args['TKT_start_date'] = date('Y-m-d h:i a', current_time('timestamp'));
+		}
+		if (empty($template_args['TKT_end_date'])) {
+			// get the earliest datetime (if present);
+			$earliest_datetime             = $this->_cpt_model_obj->ID() > 0
+				? $this->_cpt_model_obj->get_first_related(
+					'Datetime',
+					['order_by' => ['DTT_EVT_start' => 'ASC']]
+				)
+				: null;
+			$template_args['TKT_end_date'] = $earliest_datetime instanceof EE_Datetime
+				? $earliest_datetime->get_datetime('DTT_EVT_start', 'Y-m-d', 'h:i a')
+				: date('Y-m-d h:i a', mktime(0, 0, 0, date('m'), date('d') + 7, date('Y')));
+		}
+		$template_args = array_merge($template_args, $price_args);
+		$template      = apply_filters(
+			'FHEE__Events_Admin_Page__get_ticket_row__template',
+			EVENTS_TEMPLATE_PATH . 'event_tickets_metabox_ticket_row.template.php',
+			$ticket
+		);
+		return EEH_Template::display_template($template, $template_args, true);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function registration_options_meta_box()
+	{
+		$yes_no_values             = [
+			['id' => true, 'text' => esc_html__('Yes', 'event_espresso')],
+			['id' => false, 'text' => esc_html__('No', 'event_espresso')],
+		];
+		$default_reg_status_values = EEM_Registration::reg_status_array(
+			[
+				EEM_Registration::status_id_cancelled,
+				EEM_Registration::status_id_declined,
+				EEM_Registration::status_id_incomplete,
+			],
+			true
+		);
+		// $template_args['is_active_select'] = EEH_Form_Fields::select_input('is_active', $yes_no_values, $this->_cpt_model_obj->is_active());
+		$template_args['_event']                          = $this->_cpt_model_obj;
+		$template_args['event']                           = $this->_cpt_model_obj;
+		$template_args['active_status']                   = $this->_cpt_model_obj->pretty_active_status(false);
+		$template_args['additional_limit']                = $this->_cpt_model_obj->additional_limit();
+		$template_args['default_registration_status']     = EEH_Form_Fields::select_input(
+			'default_reg_status',
+			$default_reg_status_values,
+			$this->_cpt_model_obj->default_registration_status()
+		);
+		$template_args['display_description']             = EEH_Form_Fields::select_input(
+			'display_desc',
+			$yes_no_values,
+			$this->_cpt_model_obj->display_description()
+		);
+		$template_args['display_ticket_selector']         = EEH_Form_Fields::select_input(
+			'display_ticket_selector',
+			$yes_no_values,
+			$this->_cpt_model_obj->display_ticket_selector(),
+			'',
+			'',
+			false
+		);
+		$template_args['additional_registration_options'] = apply_filters(
+			'FHEE__Events_Admin_Page__registration_options_meta_box__additional_registration_options',
+			'',
+			$template_args,
+			$yes_no_values,
+			$default_reg_status_values
+		);
+		EEH_Template::display_template(
+			EVENTS_TEMPLATE_PATH . 'event_registration_options.template.php',
+			$template_args
+		);
+	}
+
+
+	/**
+	 * _get_events()
+	 * This method simply returns all the events (for the given _view and paging)
+	 *
+	 * @access public
+	 * @param int  $per_page     count of items per page (20 default);
+	 * @param int  $current_page what is the current page being viewed.
+	 * @param bool $count        if TRUE then we just return a count of ALL events matching the given _view.
+	 *                           If FALSE then we return an array of event objects
+	 *                           that match the given _view and paging parameters.
+	 * @return array|int         an array of event objects or a count of them.
+	 * @throws Exception
+	 */
+	public function get_events($per_page = 10, $current_page = 1, $count = false)
+	{
+		$EEM_Event   = $this->_event_model();
+		$offset      = ($current_page - 1) * $per_page;
+		$limit       = $count ? null : $offset . ',' . $per_page;
+		$orderby     = $this->request->getRequestParam('orderby', 'EVT_ID');
+		$order       = $this->request->getRequestParam('order', 'DESC');
+		$month_range = $this->request->getRequestParam('month_range');
+		if ($month_range) {
+			$pieces = explode(' ', $month_range, 3);
+			// simulate the FIRST day of the month, that fixes issues for months like February
+			// where PHP doesn't know what to assume for date.
+			// @see https://events.codebasehq.com/projects/event-espresso/tickets/10437
+			$month_r = ! empty($pieces[0]) ? date('m', EEH_DTT_Helper::first_of_month_timestamp($pieces[0])) : '';
+			$year_r  = ! empty($pieces[1]) ? $pieces[1] : '';
+		}
+		$where  = [];
+		$status = $this->request->getRequestParam('status');
+		// determine what post_status our condition will have for the query.
+		switch ($status) {
+			case 'month':
+			case 'today':
+			case null:
+			case 'all':
+				break;
+			case 'draft':
+				$where['status'] = ['IN', ['draft', 'auto-draft']];
+				break;
+			default:
+				$where['status'] = $status;
+		}
+		// categories? The default for all categories is -1
+		$category = $this->request->getRequestParam('EVT_CAT', -1, 'int');
+		if ($category !== -1) {
+			$where['Term_Taxonomy.taxonomy'] = EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY;
+			$where['Term_Taxonomy.term_id']  = $category;
+		}
+		// date where conditions
+		$start_formats = EEM_Datetime::instance()->get_formats_for('DTT_EVT_start');
+		if ($month_range) {
+			$DateTime = new DateTime(
+				$year_r . '-' . $month_r . '-01 00:00:00',
+				new DateTimeZone('UTC')
+			);
+			$start    = $DateTime->getTimestamp();
+			// set the datetime to be the end of the month
+			$DateTime->setDate(
+				$year_r,
+				$month_r,
+				$DateTime->format('t')
+			)->setTime(23, 59, 59);
+			$end                             = $DateTime->getTimestamp();
+			$where['Datetime.DTT_EVT_start'] = ['BETWEEN', [$start, $end]];
+		} elseif ($status === 'today') {
+			$DateTime                        =
+				new DateTime('now', new DateTimeZone(EEM_Event::instance()->get_timezone()));
+			$start                           = $DateTime->setTime(0, 0)->format(implode(' ', $start_formats));
+			$end                             = $DateTime->setTime(23, 59, 59)->format(implode(' ', $start_formats));
+			$where['Datetime.DTT_EVT_start'] = ['BETWEEN', [$start, $end]];
+		} elseif ($status === 'month') {
+			$now                             = date('Y-m-01');
+			$DateTime                        =
+				new DateTime($now, new DateTimeZone(EEM_Event::instance()->get_timezone()));
+			$start                           = $DateTime->setTime(0, 0)->format(implode(' ', $start_formats));
+			$end                             = $DateTime->setDate(date('Y'), date('m'), $DateTime->format('t'))
+														->setTime(23, 59, 59)
+														->format(implode(' ', $start_formats));
+			$where['Datetime.DTT_EVT_start'] = ['BETWEEN', [$start, $end]];
+		}
+		if (! EE_Registry::instance()->CAP->current_user_can('ee_read_others_events', 'get_events')) {
+			$where['EVT_wp_user'] = get_current_user_id();
+		} else {
+			if (! isset($where['status'])) {
+				if (! EE_Registry::instance()->CAP->current_user_can('ee_read_private_events', 'get_events')) {
+					$where['OR'] = [
+						'status*restrict_private' => ['!=', 'private'],
+						'AND'                     => [
+							'status*inclusive' => ['=', 'private'],
+							'EVT_wp_user'      => get_current_user_id(),
+						],
+					];
+				}
+			}
+		}
+		$wp_user = $this->request->getRequestParam('EVT_wp_user', 0, 'int');
+		if (
+			$wp_user
+			&& $wp_user !== get_current_user_id()
+			&& EE_Registry::instance()->CAP->current_user_can('ee_read_others_events', 'get_events')
+		) {
+			$where['EVT_wp_user'] = $wp_user;
+		}
+		// search query handling
+		$search_term = $this->request->getRequestParam('s');
+		if ($search_term) {
+			$search_term = '%' . $search_term . '%';
+			$where['OR'] = [
+				'EVT_name'       => ['LIKE', $search_term],
+				'EVT_desc'       => ['LIKE', $search_term],
+				'EVT_short_desc' => ['LIKE', $search_term],
+			];
+		}
+		// filter events by venue.
+		$venue = $this->request->getRequestParam('venue', 0, 'int');
+		if ($venue) {
+			$where['Venue.VNU_ID'] = $venue;
+		}
+		$request_params = $this->request->requestParams();
+		$where          = apply_filters('FHEE__Events_Admin_Page__get_events__where', $where, $request_params);
+		$query_params   = apply_filters(
+			'FHEE__Events_Admin_Page__get_events__query_params',
+			[
+				$where,
+				'limit'    => $limit,
+				'order_by' => $orderby,
+				'order'    => $order,
+				'group_by' => 'EVT_ID',
+			],
+			$request_params
+		);
+
+		// let's first check if we have special requests coming in.
+		$active_status = $this->request->getRequestParam('active_status');
+		if ($active_status) {
+			switch ($active_status) {
+				case 'upcoming':
+					return $EEM_Event->get_upcoming_events($query_params, $count);
+				case 'expired':
+					return $EEM_Event->get_expired_events($query_params, $count);
+				case 'active':
+					return $EEM_Event->get_active_events($query_params, $count);
+				case 'inactive':
+					return $EEM_Event->get_inactive_events($query_params, $count);
+			}
+		}
+
+		return $count ? $EEM_Event->count([$where], 'EVT_ID', true) : $EEM_Event->get_all($query_params);
+	}
+
+
+	/**
+	 * handling for WordPress CPT actions (trash, restore, delete)
+	 *
+	 * @param string $post_id
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function trash_cpt_item($post_id)
+	{
+		$this->request->setRequestParam('EVT_ID', $post_id);
+		$this->_trash_or_restore_event('trash', false);
+	}
+
+
+	/**
+	 * @param string $post_id
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function restore_cpt_item($post_id)
+	{
+		$this->request->setRequestParam('EVT_ID', $post_id);
+		$this->_trash_or_restore_event('draft', false);
+	}
+
+
+	/**
+	 * @param string $post_id
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function delete_cpt_item($post_id)
+	{
+		throw new EE_Error(
+			esc_html__(
+				'Please contact Event Espresso support with the details of the steps taken to produce this error.',
+				'event_espresso'
+			)
+		);
+		// $this->request->setRequestParam('EVT_ID', $post_id);
+		// $this->_delete_event();
+	}
+
+
+	/**
+	 * _trash_or_restore_event
+	 *
+	 * @access protected
+	 * @param string $event_status
+	 * @param bool   $redirect_after
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _trash_or_restore_event($event_status = 'trash', $redirect_after = true)
+	{
+		// determine the event id and set to array.
+		$EVT_ID = $this->request->getRequestParam('EVT_ID', 0, 'int');
+		// loop thru events
+		if ($EVT_ID) {
+			// clean status
+			$event_status = sanitize_key($event_status);
+			// grab status
+			if (! empty($event_status)) {
+				$success = $this->_change_event_status($EVT_ID, $event_status);
+			} else {
+				$success = false;
+				$msg     = esc_html__(
+					'An error occurred. The event could not be moved to the trash because a valid event status was not not supplied.',
+					'event_espresso'
+				);
+				EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			}
+		} else {
+			$success = false;
+			$msg     = esc_html__(
+				'An error occurred. The event could not be moved to the trash because a valid event ID was not not supplied.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+		$action = $event_status === 'trash' ? 'moved to the trash' : 'restored from the trash';
+		if ($redirect_after) {
+			$this->_redirect_after_action($success, 'Event', $action, ['action' => 'default']);
+		}
+	}
+
+
+	/**
+	 * _trash_or_restore_events
+	 *
+	 * @access protected
+	 * @param string $event_status
+	 * @return void
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _trash_or_restore_events($event_status = 'trash')
+	{
+		// clean status
+		$event_status = sanitize_key($event_status);
+		// grab status
+		if (! empty($event_status)) {
+			$success = true;
+			// determine the event id and set to array.
+			$EVT_IDs = $this->request->getRequestParam('EVT_IDs', [], 'int', true);
+			// loop thru events
+			foreach ($EVT_IDs as $EVT_ID) {
+				if ($EVT_ID = absint($EVT_ID)) {
+					$results = $this->_change_event_status($EVT_ID, $event_status);
+					$success = $results !== false ? $success : false;
+				} else {
+					$msg = sprintf(
+						esc_html__(
+							'An error occurred. Event #%d could not be moved to the trash because a valid event ID was not not supplied.',
+							'event_espresso'
+						),
+						$EVT_ID
+					);
+					EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+					$success = false;
+				}
+			}
+		} else {
+			$success = false;
+			$msg     = esc_html__(
+				'An error occurred. The event could not be moved to the trash because a valid event status was not not supplied.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+		// in order to force a pluralized result message we need to send back a success status greater than 1
+		$success = $success ? 2 : false;
+		$action  = $event_status === 'trash' ? 'moved to the trash' : 'restored from the trash';
+		$this->_redirect_after_action($success, 'Events', $action, ['action' => 'default']);
+	}
+
+
+	/**
+	 * @param int    $EVT_ID
+	 * @param string $event_status
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _change_event_status($EVT_ID = 0, $event_status = '')
+	{
+		// grab event id
+		if (! $EVT_ID) {
+			$msg = esc_html__(
+				'An error occurred. No Event ID or an invalid Event ID was received.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		$this->_cpt_model_obj = EEM_Event::instance()->get_one_by_ID($EVT_ID);
+		// clean status
+		$event_status = sanitize_key($event_status);
+		// grab status
+		if (empty($event_status)) {
+			$msg = esc_html__(
+				'An error occurred. No Event Status or an invalid Event Status was received.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// was event trashed or restored ?
+		switch ($event_status) {
+			case 'draft':
+				$action = 'restored from the trash';
+				$hook   = 'AHEE_event_restored_from_trash';
+				break;
+			case 'trash':
+				$action = 'moved to the trash';
+				$hook   = 'AHEE_event_moved_to_trash';
+				break;
+			default:
+				$action = 'updated';
+				$hook   = false;
+		}
+		// use class to change status
+		$this->_cpt_model_obj->set_status($event_status);
+		$success = $this->_cpt_model_obj->save();
+		if (! $success) {
+			$msg = sprintf(esc_html__('An error occurred. The event could not be %s.', 'event_espresso'), $action);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		if ($hook) {
+			do_action($hook);
+		}
+		return true;
+	}
+
+
+	/**
+	 * @param array $event_ids
+	 * @return array
+	 * @since   4.10.23.p
+	 */
+	private function cleanEventIds(array $event_ids)
+	{
+		return array_map('absint', $event_ids);
+	}
+
+
+	/**
+	 * @return array
+	 * @since   4.10.23.p
+	 */
+	private function getEventIdsFromRequest()
+	{
+		if ($this->request->requestParamIsSet('EVT_IDs')) {
+			return $this->request->getRequestParam('EVT_IDs', [], 'int', true);
+		} else {
+			return $this->request->getRequestParam('EVT_ID', [], 'int', true);
+		}
+	}
+
+
+	/**
+	 * @param bool $preview_delete
+	 * @throws EE_Error
+	 */
+	protected function _delete_event($preview_delete = true)
+	{
+		$this->_delete_events($preview_delete);
+	}
+
+
+	/**
+	 * Gets the tree traversal batch persister.
+	 *
+	 * @return NodeGroupDao
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @since 4.10.12.p
+	 */
+	protected function getModelObjNodeGroupPersister()
+	{
+		if (! $this->model_obj_node_group_persister instanceof NodeGroupDao) {
+			$this->model_obj_node_group_persister =
+				$this->getLoader()->load('\EventEspresso\core\services\orm\tree_traversal\NodeGroupDao');
+		}
+		return $this->model_obj_node_group_persister;
+	}
+
+
+	/**
+	 * @param bool $preview_delete
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function _delete_events($preview_delete = true)
+	{
+		$event_ids = $this->getEventIdsFromRequest();
+		if ($preview_delete) {
+			$this->generateDeletionPreview($event_ids);
+		} else {
+			EEM_Event::instance()->delete_permanently([['EVT_ID' => ['IN', $event_ids]]]);
+		}
+	}
+
+
+	/**
+	 * @param array $event_ids
+	 */
+	protected function generateDeletionPreview(array $event_ids)
+	{
+		$event_ids = $this->cleanEventIds($event_ids);
+		// Set a code we can use to reference this deletion task in the batch jobs and preview page.
+		$deletion_job_code = $this->getModelObjNodeGroupPersister()->generateGroupCode();
+		$return_url        = EE_Admin_Page::add_query_args_and_nonce(
+			[
+				'action'            => 'preview_deletion',
+				'deletion_job_code' => $deletion_job_code,
+			],
+			$this->_admin_base_url
+		);
+		EEH_URL::safeRedirectAndExit(
+			EE_Admin_Page::add_query_args_and_nonce(
+				[
+					'page'              => EED_Batch::PAGE_SLUG,
+					'batch'             => EED_Batch::batch_job,
+					'EVT_IDs'           => $event_ids,
+					'deletion_job_code' => $deletion_job_code,
+					'job_handler'       => urlencode('EventEspressoBatchRequest\JobHandlers\PreviewEventDeletion'),
+					'return_url'        => urlencode($return_url),
+				],
+				admin_url()
+			)
+		);
+	}
+
+
+	/**
+	 * Checks for a POST submission
+	 *
+	 * @since 4.10.12.p
+	 */
+	protected function confirmDeletion()
+	{
+		$deletion_redirect_logic =
+			$this->getLoader()->getShared('\EventEspresso\core\domain\services\admin\events\data\ConfirmDeletion');
+		$deletion_redirect_logic->handle($this->get_request_data(), $this->admin_base_url());
+	}
+
+
+	/**
+	 * A page for users to preview what exactly will be deleted, and confirm they want to delete it.
+	 *
+	 * @throws EE_Error
+	 * @since 4.10.12.p
+	 */
+	protected function previewDeletion()
+	{
+		$preview_deletion_logic =
+			$this->getLoader()->getShared('\EventEspresso\core\domain\services\admin\events\data\PreviewDeletion');
+		$this->set_template_args($preview_deletion_logic->handle($this->get_request_data(), $this->admin_base_url()));
+		$this->display_admin_page_with_no_sidebar();
+	}
+
+
+	/**
+	 * get total number of events
+	 *
+	 * @access public
+	 * @return int
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function total_events()
+	{
+		return EEM_Event::instance()->count(
+			['caps' => 'read_admin'],
+			'EVT_ID',
+			true
+		);
+	}
+
+
+	/**
+	 * get total number of draft events
+	 *
+	 * @access public
+	 * @return int
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function total_events_draft()
+	{
+		return EEM_Event::instance()->count(
+			[
+				['status' => ['IN', ['draft', 'auto-draft']]],
+				'caps' => 'read_admin',
+			],
+			'EVT_ID',
+			true
+		);
+	}
+
+
+	/**
+	 * get total number of trashed events
+	 *
+	 * @access public
+	 * @return int
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function total_trashed_events()
+	{
+		return EEM_Event::instance()->count(
+			[
+				['status' => 'trash'],
+				'caps' => 'read_admin',
+			],
+			'EVT_ID',
+			true
+		);
+	}
+
+
+	/**
+	 *    _default_event_settings
+	 *    This generates the Default Settings Tab
+	 *
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _default_event_settings()
+	{
+		$this->_set_add_edit_form_tags('update_default_event_settings');
+		$this->_set_publish_post_box_vars(null, false, false, null, false);
+		$this->_template_args['admin_page_content'] = EEH_HTML::div(
+			$this->_default_event_settings_form()->get_html(),
+			'',
+			'padding'
+		);
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * Return the form for event settings.
+	 *
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 */
+	protected function _default_event_settings_form()
+	{
+		$registration_config              = EE_Registry::instance()->CFG->registration;
+		$registration_stati_for_selection = EEM_Registration::reg_status_array(
+		// exclude
+			[
+				EEM_Registration::status_id_cancelled,
+				EEM_Registration::status_id_declined,
+				EEM_Registration::status_id_incomplete,
+				EEM_Registration::status_id_wait_list,
+			],
+			true
+		);
+		// setup Advanced Editor ???
+		if (
+			$this->raw_req_action === 'default_event_settings'
+			|| $this->raw_req_action === 'update_default_event_settings'
+		) {
+			$this->advanced_editor_admin_form = $this->loader->getShared(AdvancedEditorAdminFormSection::class);
+		}
+		return new EE_Form_Section_Proper(
+			[
+				'name'            => 'update_default_event_settings',
+				'html_id'         => 'update_default_event_settings',
+				'html_class'      => 'form-table',
+				'layout_strategy' => new EE_Admin_Two_Column_Layout(),
+				'subsections'     => apply_filters(
+					'FHEE__Events_Admin_Page___default_event_settings_form__form_subsections',
+					[
+						'defaults_section_header' => new EE_Form_Section_HTML(
+							EEH_HTML::h2(
+								esc_html__('Default Settings', 'event_espresso'),
+								'',
+								'ee-admin-settings-hdr'
+							)
+						),
+						'default_reg_status'  => new EE_Select_Input(
+							$registration_stati_for_selection,
+							[
+								'default'         => isset($registration_config->default_STS_ID)
+													 && array_key_exists(
+														 $registration_config->default_STS_ID,
+														 $registration_stati_for_selection
+													 )
+									? sanitize_text_field($registration_config->default_STS_ID)
+									: EEM_Registration::status_id_pending_payment,
+								'html_label_text' => esc_html__('Default Registration Status', 'event_espresso')
+													 . EEH_Template::get_help_tab_link(
+														 'default_settings_status_help_tab'
+													 ),
+								'html_help_text'  => esc_html__(
+									'This setting allows you to preselect what the default registration status setting is when creating an event.  Note that changing this setting does NOT retroactively apply it to existing events.',
+									'event_espresso'
+								),
+							]
+						),
+						'default_max_tickets' => new EE_Integer_Input(
+							[
+								'default'         => isset($registration_config->default_maximum_number_of_tickets)
+									? $registration_config->default_maximum_number_of_tickets
+									: EEM_Event::get_default_additional_limit(),
+								'html_label_text' => esc_html__(
+									'Default Maximum Tickets Allowed Per Order:',
+									'event_espresso'
+								)
+													 . EEH_Template::get_help_tab_link(
+														 'default_maximum_tickets_help_tab"'
+													 ),
+								'html_help_text'  => esc_html__(
+									'This setting allows you to indicate what will be the default for the maximum number of tickets per order when creating new events.',
+									'event_espresso'
+								),
+							]
+						),
+					]
+				),
+			]
+		);
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _update_default_event_settings()
+	{
+		$form = $this->_default_event_settings_form();
+		if ($form->was_submitted()) {
+			$form->receive_form_submission();
+			if ($form->is_valid()) {
+				$registration_config = EE_Registry::instance()->CFG->registration;
+				$valid_data          = $form->valid_data();
+				if (isset($valid_data['default_reg_status'])) {
+					$registration_config->default_STS_ID = $valid_data['default_reg_status'];
+				}
+				if (isset($valid_data['default_max_tickets'])) {
+					$registration_config->default_maximum_number_of_tickets = $valid_data['default_max_tickets'];
+				}
+				do_action(
+					'AHEE__Events_Admin_Page___update_default_event_settings',
+					$valid_data,
+					EE_Registry::instance()->CFG,
+					$this
+				);
+				// update because data was valid!
+				EE_Registry::instance()->CFG->update_espresso_config();
+				EE_Error::overwrite_success();
+				EE_Error::add_success(
+					esc_html__('Default Event Settings were updated', 'event_espresso')
+				);
+			}
+		}
+		$this->_redirect_after_action(0, '', '', ['action' => 'default_event_settings'], true);
+	}
+
+
+	/*************        Templates        *************
      *
-     * @var EE_Event $_event
-     */
-    protected $_event;
-
-
-    /**
-     * This will hold the category object for category_details screen.
-     *
-     * @var stdClass $_category
-     */
-    protected $_category;
-
-
-    /**
-     * This will hold the event model instance
-     *
-     * @var EEM_Event $_event_model
-     */
-    protected $_event_model;
-
-
-    /**
-     * @var EE_Event
-     */
-    protected $_cpt_model_obj = false;
-
-
-    /**
-     * @var NodeGroupDao
-     */
-    protected $model_obj_node_group_persister;
-
-    /**
-     * @var AdvancedEditorAdminFormSection
-     */
-    protected $advanced_editor_admin_form;
-
-
-    /**
-     * Initialize page props for this admin page group.
-     */
-    protected function _init_page_props()
-    {
-        $this->page_slug        = EVENTS_PG_SLUG;
-        $this->page_label       = EVENTS_LABEL;
-        $this->_admin_base_url  = EVENTS_ADMIN_URL;
-        $this->_admin_base_path = EVENTS_ADMIN;
-        $this->_cpt_model_names = [
-            'create_new' => 'EEM_Event',
-            'edit'       => 'EEM_Event',
-        ];
-        $this->_cpt_edit_routes = [
-            'espresso_events' => 'edit',
-        ];
-        add_action(
-            'AHEE__EE_Admin_Page_CPT__set_model_object__after_set_object',
-            [$this, 'verify_event_edit'],
-            10,
-            2
-        );
-    }
-
-
-    /**
-     * Sets the ajax hooks used for this admin page group.
-     */
-    protected function _ajax_hooks()
-    {
-        add_action('wp_ajax_ee_save_timezone_setting', [$this, 'saveTimezoneString']);
-    }
-
-
-    /**
-     * Sets the page properties for this admin page group.
-     */
-    protected function _define_page_props()
-    {
-        $this->_admin_page_title = EVENTS_LABEL;
-        $this->_labels           = [
-            'buttons'      => [
-                'add'             => esc_html__('Add New Event', 'event_espresso'),
-                'edit'            => esc_html__('Edit Event', 'event_espresso'),
-                'delete'          => esc_html__('Delete Event', 'event_espresso'),
-                'add_category'    => esc_html__('Add New Category', 'event_espresso'),
-                'edit_category'   => esc_html__('Edit Category', 'event_espresso'),
-                'delete_category' => esc_html__('Delete Category', 'event_espresso'),
-            ],
-            'editor_title' => [
-                'espresso_events' => esc_html__('Enter event title here', 'event_espresso'),
-            ],
-            'publishbox'   => [
-                'create_new'        => esc_html__('Save New Event', 'event_espresso'),
-                'edit'              => esc_html__('Update Event', 'event_espresso'),
-                'add_category'      => esc_html__('Save New Category', 'event_espresso'),
-                'edit_category'     => esc_html__('Update Category', 'event_espresso'),
-                'template_settings' => esc_html__('Update Settings', 'event_espresso'),
-            ],
-        ];
-    }
-
-
-    /**
-     * Sets the page routes property for this admin page group.
-     */
-    protected function _set_page_routes()
-    {
-        // load formatter helper
-        // load field generator helper
-        // is there a evt_id in the request?
-        $EVT_ID = $this->request->getRequestParam('EVT_ID', 0, 'int');
-        $EVT_ID = $this->request->getRequestParam('post', $EVT_ID, 'int');
-
-        $this->_page_routes = [
-            'default'                       => [
-                'func'       => '_events_overview_list_table',
-                'capability' => 'ee_read_events',
-            ],
-            'create_new'                    => [
-                'func'       => '_create_new_cpt_item',
-                'capability' => 'ee_edit_events',
-            ],
-            'edit'                          => [
-                'func'       => '_edit_cpt_item',
-                'capability' => 'ee_edit_event',
-                'obj_id'     => $EVT_ID,
-            ],
-            'copy_event'                    => [
-                'func'       => '_copy_events',
-                'capability' => 'ee_edit_event',
-                'obj_id'     => $EVT_ID,
-                'noheader'   => true,
-            ],
-            'trash_event'                   => [
-                'func'       => '_trash_or_restore_event',
-                'args'       => ['event_status' => 'trash'],
-                'capability' => 'ee_delete_event',
-                'obj_id'     => $EVT_ID,
-                'noheader'   => true,
-            ],
-            'trash_events'                  => [
-                'func'       => '_trash_or_restore_events',
-                'args'       => ['event_status' => 'trash'],
-                'capability' => 'ee_delete_events',
-                'noheader'   => true,
-            ],
-            'restore_event'                 => [
-                'func'       => '_trash_or_restore_event',
-                'args'       => ['event_status' => 'draft'],
-                'capability' => 'ee_delete_event',
-                'obj_id'     => $EVT_ID,
-                'noheader'   => true,
-            ],
-            'restore_events'                => [
-                'func'       => '_trash_or_restore_events',
-                'args'       => ['event_status' => 'draft'],
-                'capability' => 'ee_delete_events',
-                'noheader'   => true,
-            ],
-            'delete_event'                  => [
-                'func'       => '_delete_event',
-                'capability' => 'ee_delete_event',
-                'obj_id'     => $EVT_ID,
-                'noheader'   => true,
-            ],
-            'delete_events'                 => [
-                'func'       => '_delete_events',
-                'capability' => 'ee_delete_events',
-                'noheader'   => true,
-            ],
-            'view_report'                   => [
-                'func'       => '_view_report',
-                'capability' => 'ee_edit_events',
-            ],
-            'default_event_settings'        => [
-                'func'       => '_default_event_settings',
-                'capability' => 'manage_options',
-            ],
-            'update_default_event_settings' => [
-                'func'       => '_update_default_event_settings',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ],
-            'template_settings'             => [
-                'func'       => '_template_settings',
-                'capability' => 'manage_options',
-            ],
-            // event category tab related
-            'add_category'                  => [
-                'func'       => '_category_details',
-                'capability' => 'ee_edit_event_category',
-                'args'       => ['add'],
-            ],
-            'edit_category'                 => [
-                'func'       => '_category_details',
-                'capability' => 'ee_edit_event_category',
-                'args'       => ['edit'],
-            ],
-            'delete_categories'             => [
-                'func'       => '_delete_categories',
-                'capability' => 'ee_delete_event_category',
-                'noheader'   => true,
-            ],
-            'delete_category'               => [
-                'func'       => '_delete_categories',
-                'capability' => 'ee_delete_event_category',
-                'noheader'   => true,
-            ],
-            'insert_category'               => [
-                'func'       => '_insert_or_update_category',
-                'args'       => ['new_category' => true],
-                'capability' => 'ee_edit_event_category',
-                'noheader'   => true,
-            ],
-            'update_category'               => [
-                'func'       => '_insert_or_update_category',
-                'args'       => ['new_category' => false],
-                'capability' => 'ee_edit_event_category',
-                'noheader'   => true,
-            ],
-            'category_list'                 => [
-                'func'       => '_category_list_table',
-                'capability' => 'ee_manage_event_categories',
-            ],
-            'preview_deletion'              => [
-                'func'       => 'previewDeletion',
-                'capability' => 'ee_delete_events',
-            ],
-            'confirm_deletion'              => [
-                'func'       => 'confirmDeletion',
-                'capability' => 'ee_delete_events',
-                'noheader'   => true,
-            ],
-        ];
-    }
-
-
-    /**
-     * Set the _page_config property for this admin page group.
-     */
-    protected function _set_page_config()
-    {
-        $post_id            = $this->request->getRequestParam('post', 0, 'int');
-        $EVT_CAT_ID         = $this->request->getRequestParam('EVT_CAT_ID', 0, 'int');
-        $this->_page_config = [
-            'default'                => [
-                'nav'           => [
-                    'label' => esc_html__('Overview', 'event_espresso'),
-                    'icon' => 'dashicons-list-view',
-                    'order' => 10,
-                ],
-                'list_table'    => 'Events_Admin_List_Table',
-                'help_tabs'     => [
-                    'events_overview_help_tab'                       => [
-                        'title'    => esc_html__('Events Overview', 'event_espresso'),
-                        'filename' => 'events_overview',
-                    ],
-                    'events_overview_table_column_headings_help_tab' => [
-                        'title'    => esc_html__('Events Overview Table Column Headings', 'event_espresso'),
-                        'filename' => 'events_overview_table_column_headings',
-                    ],
-                    'events_overview_filters_help_tab'               => [
-                        'title'    => esc_html__('Events Overview Filters', 'event_espresso'),
-                        'filename' => 'events_overview_filters',
-                    ],
-                    'events_overview_view_help_tab'                  => [
-                        'title'    => esc_html__('Events Overview Views', 'event_espresso'),
-                        'filename' => 'events_overview_views',
-                    ],
-                    'events_overview_other_help_tab'                 => [
-                        'title'    => esc_html__('Events Overview Other', 'event_espresso'),
-                        'filename' => 'events_overview_other',
-                    ],
-                ],
-                'require_nonce' => false,
-            ],
-            'create_new'             => [
-                'nav'           => [
-                    'label'      => esc_html__('Add New Event', 'event_espresso'),
-                    'icon' => 'dashicons-plus-alt',
-                    'order'      => 5,
-                    'persistent' => false,
-                ],
-                'metaboxes'     => ['_register_event_editor_meta_boxes'],
-                'help_tabs'     => [
-                    'event_editor_help_tab'                            => [
-                        'title'    => esc_html__('Event Editor', 'event_espresso'),
-                        'filename' => 'event_editor',
-                    ],
-                    'event_editor_title_richtexteditor_help_tab'       => [
-                        'title'    => esc_html__('Event Title & Rich Text Editor', 'event_espresso'),
-                        'filename' => 'event_editor_title_richtexteditor',
-                    ],
-                    'event_editor_venue_details_help_tab'              => [
-                        'title'    => esc_html__('Event Venue Details', 'event_espresso'),
-                        'filename' => 'event_editor_venue_details',
-                    ],
-                    'event_editor_event_datetimes_help_tab'            => [
-                        'title'    => esc_html__('Event Datetimes', 'event_espresso'),
-                        'filename' => 'event_editor_event_datetimes',
-                    ],
-                    'event_editor_event_tickets_help_tab'              => [
-                        'title'    => esc_html__('Event Tickets', 'event_espresso'),
-                        'filename' => 'event_editor_event_tickets',
-                    ],
-                    'event_editor_event_registration_options_help_tab' => [
-                        'title'    => esc_html__('Event Registration Options', 'event_espresso'),
-                        'filename' => 'event_editor_event_registration_options',
-                    ],
-                    'event_editor_tags_categories_help_tab'            => [
-                        'title'    => esc_html__('Event Tags & Categories', 'event_espresso'),
-                        'filename' => 'event_editor_tags_categories',
-                    ],
-                    'event_editor_questions_registrants_help_tab'      => [
-                        'title'    => esc_html__('Questions for Registrants', 'event_espresso'),
-                        'filename' => 'event_editor_questions_registrants',
-                    ],
-                    'event_editor_save_new_event_help_tab'             => [
-                        'title'    => esc_html__('Save New Event', 'event_espresso'),
-                        'filename' => 'event_editor_save_new_event',
-                    ],
-                    'event_editor_other_help_tab'                      => [
-                        'title'    => esc_html__('Event Other', 'event_espresso'),
-                        'filename' => 'event_editor_other',
-                    ],
-                ],
-                'qtips'         => ['EE_Event_Editor_Decaf_Tips'],
-                'require_nonce' => false,
-            ],
-            'edit'                   => [
-                'nav'           => [
-                    'label'      => esc_html__('Edit Event', 'event_espresso'),
-                    'icon' => 'dashicons-edit',
-                    'order'      => 5,
-                    'persistent' => false,
-                    'url'        => $post_id
-                        ? EE_Admin_Page::add_query_args_and_nonce(
-                            ['post' => $post_id, 'action' => 'edit'],
-                            $this->_current_page_view_url
-                        )
-                        : $this->_admin_base_url,
-                ],
-                'metaboxes'     => ['_register_event_editor_meta_boxes'],
-                'help_tabs'     => [
-                    'event_editor_help_tab'                            => [
-                        'title'    => esc_html__('Event Editor', 'event_espresso'),
-                        'filename' => 'event_editor',
-                    ],
-                    'event_editor_title_richtexteditor_help_tab'       => [
-                        'title'    => esc_html__('Event Title & Rich Text Editor', 'event_espresso'),
-                        'filename' => 'event_editor_title_richtexteditor',
-                    ],
-                    'event_editor_venue_details_help_tab'              => [
-                        'title'    => esc_html__('Event Venue Details', 'event_espresso'),
-                        'filename' => 'event_editor_venue_details',
-                    ],
-                    'event_editor_event_datetimes_help_tab'            => [
-                        'title'    => esc_html__('Event Datetimes', 'event_espresso'),
-                        'filename' => 'event_editor_event_datetimes',
-                    ],
-                    'event_editor_event_tickets_help_tab'              => [
-                        'title'    => esc_html__('Event Tickets', 'event_espresso'),
-                        'filename' => 'event_editor_event_tickets',
-                    ],
-                    'event_editor_event_registration_options_help_tab' => [
-                        'title'    => esc_html__('Event Registration Options', 'event_espresso'),
-                        'filename' => 'event_editor_event_registration_options',
-                    ],
-                    'event_editor_tags_categories_help_tab'            => [
-                        'title'    => esc_html__('Event Tags & Categories', 'event_espresso'),
-                        'filename' => 'event_editor_tags_categories',
-                    ],
-                    'event_editor_questions_registrants_help_tab'      => [
-                        'title'    => esc_html__('Questions for Registrants', 'event_espresso'),
-                        'filename' => 'event_editor_questions_registrants',
-                    ],
-                    'event_editor_save_new_event_help_tab'             => [
-                        'title'    => esc_html__('Save New Event', 'event_espresso'),
-                        'filename' => 'event_editor_save_new_event',
-                    ],
-                    'event_editor_other_help_tab'                      => [
-                        'title'    => esc_html__('Event Other', 'event_espresso'),
-                        'filename' => 'event_editor_other',
-                    ],
-                ],
-                'require_nonce' => false,
-            ],
-            'default_event_settings' => [
-                'nav'           => [
-                    'label' => esc_html__('Default Settings', 'event_espresso'),
-                    'icon' => 'dashicons-admin-generic',
-                    'order' => 40,
-                ],
-                'metaboxes'     => array_merge(['_publish_post_box'], $this->_default_espresso_metaboxes),
-                'labels'        => [
-                    'publishbox' => esc_html__('Update Settings', 'event_espresso'),
-                ],
-                'help_tabs'     => [
-                    'default_settings_help_tab'        => [
-                        'title'    => esc_html__('Default Event Settings', 'event_espresso'),
-                        'filename' => 'events_default_settings',
-                    ],
-                    'default_settings_status_help_tab' => [
-                        'title'    => esc_html__('Default Registration Status', 'event_espresso'),
-                        'filename' => 'events_default_settings_status',
-                    ],
-                    'default_maximum_tickets_help_tab' => [
-                        'title'    => esc_html__('Default Maximum Tickets Per Order', 'event_espresso'),
-                        'filename' => 'events_default_settings_max_tickets',
-                    ],
-                ],
-                'require_nonce' => false,
-            ],
-            // template settings
-            'template_settings'      => [
-                'nav'           => [
-                    'label' => esc_html__( 'Templates', 'event_espresso'),
-                    'icon' => 'dashicons-layout',
-                    'order' => 30,
-                ],
-                'metaboxes'     => $this->_default_espresso_metaboxes,
-                'help_tabs'     => [
-                    'general_settings_templates_help_tab' => [
-                        'title'    => esc_html__('Templates', 'event_espresso'),
-                        'filename' => 'general_settings_templates',
-                    ],
-                ],
-                'require_nonce' => false,
-            ],
-            // event category stuff
-            'add_category'           => [
-                'nav'           => [
-                    'label'      => esc_html__('Add Category', 'event_espresso'),
-                    'icon' => 'dashicons-plus-alt',
-                    'order'      => 25,
-                    'persistent' => false,
-                ],
-                'help_tabs'     => [
-                    'add_category_help_tab' => [
-                        'title'    => esc_html__('Add New Event Category', 'event_espresso'),
-                        'filename' => 'events_add_category',
-                    ],
-                ],
-                'metaboxes'     => ['_publish_post_box'],
-                'require_nonce' => false,
-            ],
-            'edit_category'          => [
-                'nav'           => [
-                    'label'      => esc_html__('Edit Category', 'event_espresso'),
-                    'icon' => 'dashicons-edit',
-                    'order'      => 25,
-                    'persistent' => false,
-                    'url'        => $EVT_CAT_ID
-                        ? add_query_arg(
-                            ['EVT_CAT_ID' => $EVT_CAT_ID],
-                            $this->_current_page_view_url
-                        )
-                        : $this->_admin_base_url,
-                ],
-                'help_tabs'     => [
-                    'edit_category_help_tab' => [
-                        'title'    => esc_html__('Edit Event Category', 'event_espresso'),
-                        'filename' => 'events_edit_category',
-                    ],
-                ],
-                'metaboxes'     => ['_publish_post_box'],
-                'require_nonce' => false,
-            ],
-            'category_list'          => [
-                'nav'           => [
-                    'label' => esc_html__('Categories', 'event_espresso'),
-                    'icon' => 'dashicons-networking',
-                    'order' => 20,
-                ],
-                'list_table'    => 'Event_Categories_Admin_List_Table',
-                'help_tabs'     => [
-                    'events_categories_help_tab'                       => [
-                        'title'    => esc_html__('Event Categories', 'event_espresso'),
-                        'filename' => 'events_categories',
-                    ],
-                    'events_categories_table_column_headings_help_tab' => [
-                        'title'    => esc_html__('Event Categories Table Column Headings', 'event_espresso'),
-                        'filename' => 'events_categories_table_column_headings',
-                    ],
-                    'events_categories_view_help_tab'                  => [
-                        'title'    => esc_html__('Event Categories Views', 'event_espresso'),
-                        'filename' => 'events_categories_views',
-                    ],
-                    'events_categories_other_help_tab'                 => [
-                        'title'    => esc_html__('Event Categories Other', 'event_espresso'),
-                        'filename' => 'events_categories_other',
-                    ],
-                ],
-                'metaboxes'     => $this->_default_espresso_metaboxes,
-                'require_nonce' => false,
-            ],
-            'preview_deletion'       => [
-                'nav'           => [
-                    'label'      => esc_html__('Preview Deletion', 'event_espresso'),
-                    'icon' => 'dashicons-remove',
-                    'order'      => 15,
-                    'persistent' => false,
-                    'url'        => '',
-                ],
-                'require_nonce' => false,
-            ],
-        ];
-    }
-
-
-    /**
-     * Used to register any global screen options if necessary for every route in this admin page group.
-     */
-    protected function _add_screen_options()
-    {
-    }
-
-
-    /**
-     * Implementing the screen options for the 'default' route.
-     *
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _add_screen_options_default()
-    {
-        $this->_per_page_screen_option();
-    }
-
-
-    /**
-     * Implementing screen options for the category list route.
-     *
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _add_screen_options_category_list()
-    {
-        $page_title              = $this->_admin_page_title;
-        $this->_admin_page_title = esc_html__('Categories', 'event_espresso');
-        $this->_per_page_screen_option();
-        $this->_admin_page_title = $page_title;
-    }
-
-
-    /**
-     * Used to register any global feature pointers for the admin page group.
-     */
-    protected function _add_feature_pointers()
-    {
-    }
-
-
-    /**
-     * Registers and enqueues any global scripts and styles for the entire admin page group.
-     */
-    public function load_scripts_styles()
-    {
-        wp_register_style(
-            'events-admin-css',
-            EVENTS_ASSETS_URL . 'events-admin-page.css',
-            [],
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_register_style(
-            'ee-cat-admin',
-            EVENTS_ASSETS_URL . 'ee-cat-admin.css',
-            [],
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('events-admin-css');
-        wp_enqueue_style('ee-cat-admin');
-        // scripts
-        wp_register_script(
-            'event_editor_js',
-            EVENTS_ASSETS_URL . 'event_editor.js',
-            ['ee_admin_js', 'jquery-ui-slider', 'jquery-ui-timepicker-addon'],
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-    }
-
-
-    /**
-     * Enqueuing scripts and styles specific to this view
-     */
-    public function load_scripts_styles_create_new()
-    {
-        $this->load_scripts_styles_edit();
-    }
-
-
-    /**
-     * Enqueuing scripts and styles specific to this view
-     */
-    public function load_scripts_styles_edit()
-    {
-        // styles
-        wp_enqueue_style('espresso-ui-theme');
-        wp_register_style(
-            'event-editor-css',
-            EVENTS_ASSETS_URL . 'event-editor.css',
-            ['ee-admin-css'],
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('event-editor-css');
-        // scripts
-        if (! $this->admin_config->useAdvancedEditor()) {
-            wp_register_script(
-                'event-datetime-metabox',
-                EVENTS_ASSETS_URL . 'event-datetime-metabox.js',
-                ['event_editor_js', 'ee-datepicker'],
-                EVENT_ESPRESSO_VERSION
-            );
-            wp_enqueue_script('event-datetime-metabox');
-        }
-    }
-
-
-    /**
-     * Populating the _views property for the category list table view.
-     */
-    protected function _set_list_table_views_category_list()
-    {
-        $this->_views = [
-            'all' => [
-                'slug'        => 'all',
-                'label'       => esc_html__('All', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => [
-                    'delete_categories' => esc_html__('Delete Permanently', 'event_espresso'),
-                ],
-            ],
-        ];
-    }
-
-
-    /**
-     * For adding anything that fires on the admin_init hook for any route within this admin page group.
-     */
-    public function admin_init()
-    {
-        EE_Registry::$i18n_js_strings['image_confirm'] = esc_html__(
-            'Do you really want to delete this image? Please remember to update your event to complete the removal.',
-            'event_espresso'
-        );
-    }
-
-
-    /**
-     * For adding anything that should be triggered on the admin_notices hook for any route within this admin page
-     * group.
-     */
-    public function admin_notices()
-    {
-    }
-
-
-    /**
-     * For adding anything that should be triggered on the `admin_print_footer_scripts` hook for any route within
-     * this admin page group.
-     */
-    public function admin_footer_scripts()
-    {
-    }
-
-
-    /**
-     * Call this function to verify if an event is public and has tickets for sale.  If it does, then we need to show a
-     * warning (via EE_Error::add_error());
-     *
-     * @param EE_Event $event Event object
-     * @param string   $req_type
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function verify_event_edit($event = null, $req_type = '')
-    {
-        // don't need to do this when processing
-        if (! empty($req_type)) {
-            return;
-        }
-        // no event?
-        if (! $event instanceof EE_Event) {
-            $event = $this->_cpt_model_obj;
-        }
-        // STILL no event?
-        if (! $event instanceof EE_Event) {
-            return;
-        }
-        $orig_status = $event->status();
-        // first check if event is active.
-        if (
-            $orig_status === EEM_Event::cancelled
-            || $orig_status === EEM_Event::postponed
-            || $event->is_expired()
-            || $event->is_inactive()
-        ) {
-            return;
-        }
-        // made it here so it IS active... next check that any of the tickets are sold.
-        if ($event->is_sold_out(true)) {
-            if ($orig_status !== EEM_Event::sold_out && $event->status() !== $orig_status) {
-                EE_Error::add_attention(
-                    sprintf(
-                        esc_html__(
-                            'Please note that the Event Status has automatically been changed to %s because there are no more spaces available for this event.  However, this change is not permanent until you update the event.  You can change the status back to something else before updating if you wish.',
-                            'event_espresso'
-                        ),
-                        EEH_Template::pretty_status(EEM_Event::sold_out, false, 'sentence')
-                    )
-                );
-            }
-            return;
-        }
-        if ($orig_status === EEM_Event::sold_out) {
-            EE_Error::add_attention(
-                sprintf(
-                    esc_html__(
-                        'Please note that the Event Status has automatically been changed to %s because more spaces have become available for this event, most likely due to abandoned transactions freeing up reserved tickets.  However, this change is not permanent until you update the event. If you wish, you can change the status back to something else before updating.',
-                        'event_espresso'
-                    ),
-                    EEH_Template::pretty_status($event->status(), false, 'sentence')
-                )
-            );
-        }
-        // now we need to determine if the event has any tickets on sale.  If not then we dont' show the error
-        if (! $event->tickets_on_sale()) {
-            return;
-        }
-        // made it here so show warning
-        $this->_edit_event_warning();
-    }
-
-
-    /**
-     * This is the text used for when an event is being edited that is public and has tickets for sale.
-     * When needed, hook this into a EE_Error::add_error() notice.
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _edit_event_warning()
-    {
-        // we don't want to add warnings during these requests
-        if ($this->request->getRequestParam('action') === 'editpost') {
-            return;
-        }
-        EE_Error::add_attention(
-            sprintf(
-                esc_html__(
-                    'Your event is open for registration. Making changes may disrupt any transactions in progress. %sLearn more%s',
-                    'event_espresso'
-                ),
-                '<a class="espresso-help-tab-lnk ee-help-tab-link">',
-                '</a>'
-            )
-        );
-    }
-
-
-    /**
-     * When a user is creating a new event, notify them if they haven't set their timezone.
-     * Otherwise, do the normal logic
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _create_new_cpt_item()
-    {
-        $has_timezone_string = get_option('timezone_string');
-        // only nag them about setting their timezone if it's their first event, and they haven't already done it
-        if (! $has_timezone_string && ! EEM_Event::instance()->exists([])) {
-            EE_Error::add_attention(
-                sprintf(
-                    esc_html__(
-                        'Your website\'s timezone is currently set to a UTC offset. We recommend updating your timezone to a city or region near you before you create an event. Change your timezone now:%1$s%2$s%3$sChange Timezone%4$s',
-                        'event_espresso'
-                    ),
-                    '<br>',
-                    '<select id="timezone_string" name="timezone_string" aria-describedby="timezone-description">'
-                    . EEH_DTT_Helper::wp_timezone_choice('', EEH_DTT_Helper::get_user_locale())
-                    . '</select>',
-                    '<button class="button button--secondary timezone-submit">',
-                    '</button><span class="spinner"></span>'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        parent::_create_new_cpt_item();
-    }
-
-
-    /**
-     * Sets the _views property for the default route in this admin page group.
-     */
-    protected function _set_list_table_views_default()
-    {
-        $this->_views = [
-            'all'   => [
-                'slug'        => 'all',
-                'label'       => esc_html__('View All Events', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => [
-                    'trash_events' => esc_html__('Move to Trash', 'event_espresso'),
-                ],
-            ],
-            'draft' => [
-                'slug'        => 'draft',
-                'label'       => esc_html__('Draft', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => [
-                    'trash_events' => esc_html__('Move to Trash', 'event_espresso'),
-                ],
-            ],
-        ];
-        if (EE_Registry::instance()->CAP->current_user_can('ee_delete_events', 'espresso_events_trash_events')) {
-            $this->_views['trash'] = [
-                'slug'        => 'trash',
-                'label'       => esc_html__('Trash', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => [
-                    'restore_events' => esc_html__('Restore From Trash', 'event_espresso'),
-                    'delete_events'  => esc_html__('Delete Permanently', 'event_espresso'),
-                ],
-            ];
-        }
-    }
-
-
-    /**
-     * Provides the legend item array for the default list table view.
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    protected function _event_legend_items()
-    {
-        $items    = [
-            'view_details'   => [
-                'class' => 'dashicons dashicons-visibility',
-                'desc'  => esc_html__('View Event', 'event_espresso'),
-            ],
-            'edit_event'     => [
-                'class' => 'dashicons dashicons-calendar-alt',
-                'desc'  => esc_html__('Edit Event Details', 'event_espresso'),
-            ],
-            'view_attendees' => [
-                'class' => 'dashicons dashicons-groups',
-                'desc'  => esc_html__('View Registrations for Event', 'event_espresso'),
-            ],
-        ];
-        $items    = apply_filters('FHEE__Events_Admin_Page___event_legend_items__items', $items);
-        $statuses = [
-            'sold_out_status'  => [
-                'class' => 'ee-status-legend ee-status-bg--' . EE_Datetime::sold_out,
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::sold_out, false, 'sentence'),
-            ],
-            'active_status'    => [
-                'class' => 'ee-status-legend ee-status-bg--' . EE_Datetime::active,
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::active, false, 'sentence'),
-            ],
-            'upcoming_status'  => [
-                'class' => 'ee-status-legend ee-status-bg--' . EE_Datetime::upcoming,
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::upcoming, false, 'sentence'),
-            ],
-            'postponed_status' => [
-                'class' => 'ee-status-legend ee-status-bg--' . EE_Datetime::postponed,
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::postponed, false, 'sentence'),
-            ],
-            'cancelled_status' => [
-                'class' => 'ee-status-legend ee-status-bg--' . EE_Datetime::cancelled,
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::cancelled, false, 'sentence'),
-            ],
-            'expired_status'   => [
-                'class' => 'ee-status-legend ee-status-bg--' . EE_Datetime::expired,
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::expired, false, 'sentence'),
-            ],
-            'inactive_status'  => [
-                'class' => 'ee-status-legend ee-status-bg--' . EE_Datetime::inactive,
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::inactive, false, 'sentence'),
-            ],
-        ];
-        $statuses = apply_filters('FHEE__Events_Admin_Page__event_legend_items__statuses', $statuses);
-        return array_merge($items, $statuses);
-    }
-
-
-    /**
-     * @return EEM_Event
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function _event_model()
-    {
-        if (! $this->_event_model instanceof EEM_Event) {
-            $this->_event_model = EE_Registry::instance()->load_model('Event');
-        }
-        return $this->_event_model;
-    }
-
-
-    /**
-     * Adds extra buttons to the WP CPT permalink field row.
-     * 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
-     * @param string $new_title What the title is
-     * @param string $new_slug  what the slug is
-     * @return string            The new html string for the permalink area
-     */
-    public function extra_permalink_field_buttons($return, $id, $new_title, $new_slug)
-    {
-        // make sure this is only when editing
-        if (! empty($id)) {
-            $post = get_post($id);
-            $return .= '<a class="button button--small button--secondary" onclick="prompt(\'Shortcode:\', jQuery(\'#shortcode\').val()); return false;" href="#"  tabindex="-1">'
-                       . esc_html__('Shortcode', 'event_espresso')
-                       . '</a> ';
-            $return .= '<input id="shortcode" type="hidden" value="[ESPRESSO_TICKET_SELECTOR event_id='
-                       . $post->ID
-                       . ']">';
-        }
-        return $return;
-    }
-
-
-    /**
-     * _events_overview_list_table
-     * This contains the logic for showing the events_overview list
-     *
-     * @access protected
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _events_overview_list_table()
-    {
-        $after_list_table                           = [];
-        $links_html = EEH_HTML::div('', '', 'ee-admin-section ee-layout-stack');
-        $links_html .= EEH_HTML::h3(esc_html__('Links', 'event_espresso'));
-        $links_html .= EEH_HTML::div(
-            EEH_Template::get_button_or_link(
-                get_post_type_archive_link('espresso_events'),
-                esc_html__('View Event Archive Page', 'event_espresso'),
-                'button button--small button--secondary'
-            ),
-            '',
-            'ee-admin-button-row ee-admin-button-row--align-start'
-        );
-        $links_html .= EEH_HTML::divx();
-
-        $after_list_table['view_event_list_button'] = $links_html;
-
-        $after_list_table['legend'] = $this->_display_legend($this->_event_legend_items());
-        $this->_admin_page_title                    .= ' ' . $this->get_action_link_or_button(
-            'create_new',
-            'add',
-            [],
-            'add-new-h2'
-        );
-
-        $this->_template_args['after_list_table']   = array_merge(
-            (array) $this->_template_args['after_list_table'],
-            $after_list_table
-        );
-        $this->display_admin_list_table_page_with_no_sidebar();
-    }
-
-
-    /**
-     * this allows for extra misc actions in the default WP publish box
-     *
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function extra_misc_actions_publish_box()
-    {
-        $this->_generate_publish_box_extra_content();
-    }
-
-
-    /**
-     * This is hooked into the WordPress do_action('save_post') hook and runs after the custom post type has been
-     * saved.
-     * 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.
-     *
-     * @access protected
-     * @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
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _insert_update_cpt_item($post_id, $post)
-    {
-        if ($post instanceof WP_Post && $post->post_type !== 'espresso_events') {
-            // get out we're not processing an event save.
-            return;
-        }
-        $event_values = [
-            'EVT_member_only'     => $this->request->getRequestParam('member_only', false, 'bool'),
-            'EVT_allow_overflow'  => $this->request->getRequestParam('EVT_allow_overflow', false, 'bool'),
-            'EVT_timezone_string' => $this->request->getRequestParam('timezone_string'),
-        ];
-        // check if the new EDTR reg options meta box is being used, and if so, don't run updates for legacy version
-        if (! $this->admin_config->useAdvancedEditor() || ! $this->feature->allowed('use_reg_options_meta_box')) {
-            $event_values['EVT_display_ticket_selector']     = $this->request->getRequestParam(
-                'display_ticket_selector',
-                false,
-                'bool'
-            );
-            $event_values['EVT_additional_limit']            = min(
-                apply_filters('FHEE__EE_Events_Admin__insert_update_cpt_item__EVT_additional_limit_max', 255),
-                $this->request->getRequestParam('additional_limit', null, 'int')
-            );
-            $event_values['EVT_default_registration_status'] = $this->request->getRequestParam(
-                'EVT_default_registration_status',
-                EE_Registry::instance()->CFG->registration->default_STS_ID
-            );
-
-            $event_values['EVT_external_URL'] = $this->request->getRequestParam('externalURL');
-            $event_values['EVT_phone']        = $this->request->getRequestParam('event_phone');
-            $event_values['EVT_display_desc'] = $this->request->getRequestParam('display_desc', false, 'bool');
-        }
-        // update event
-        $success = $this->_event_model()->update_by_ID($event_values, $post_id);
-        // get event_object for other metaboxes...
-        // though it would seem to make sense to just use $this->_event_model()->get_one_by_ID( $post_id )..
-        // i have to setup where conditions to override the filters in the model
-        // that filter out autodraft and inherit statuses so we GET the inherit id!
-        $event = $this->_event_model()->get_one(
-            [
-                [
-                    $this->_event_model()->primary_key_name() => $post_id,
-                    'OR'                                      => [
-                        'status'   => $post->post_status,
-                        // if trying to "Publish" a sold out event, it's status will get switched back to "sold_out" in the db,
-                        // but the returned object here has a status of "publish", so use the original post status as well
-                        'status*1' => $this->request->getRequestParam('original_post_status'),
-                    ],
-                ],
-            ]
-        );
-
-        // the following are default callbacks for event attachment updates
-        // that can be overridden by caffeinated functionality and/or addons.
-        $event_update_callbacks = [];
-        if (! $this->admin_config->useAdvancedEditor()) {
-            $event_update_callbacks['_default_venue_update']   = [$this, '_default_venue_update'];
-            $event_update_callbacks['_default_tickets_update'] = [$this, '_default_tickets_update'];
-        }
-        $event_update_callbacks = apply_filters(
-            'FHEE__Events_Admin_Page___insert_update_cpt_item__event_update_callbacks',
-            $event_update_callbacks
-        );
-
-        $att_success = true;
-        foreach ($event_update_callbacks as $e_callback) {
-            $_success = is_callable($e_callback)
-                ? $e_callback($event, $this->request->requestParams())
-                : false;
-            // if ANY of these updates fail then we want the appropriate global error message
-            $att_success = $_success !== false ? $att_success : false;
-        }
-        // any errors?
-        if ($success && $att_success === false) {
-            EE_Error::add_error(
-                esc_html__(
-                    'Event Details saved successfully but something went wrong with saving attachments.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        } elseif ($success === false) {
-            EE_Error::add_error(
-                esc_html__('Event Details did not save successfully.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-    }
-
-
-    /**
-     * @param int $post_id
-     * @param int $revision_id
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @see parent::restore_item()
-     */
-    protected function _restore_cpt_item($post_id, $revision_id)
-    {
-        // copy existing event meta to new post
-        $post_evt = $this->_event_model()->get_one_by_ID($post_id);
-        if ($post_evt instanceof EE_Event) {
-            // meta revision restore
-            $post_evt->restore_revision($revision_id);
-            // related objs restore
-            $post_evt->restore_revision($revision_id, ['Venue', 'Datetime', 'Price']);
-        }
-    }
-
-
-    /**
-     * Attach the venue to the Event
-     *
-     * @param EE_Event $event Event Object to add the venue to
-     * @param array    $data  The request data from the form
-     * @return bool           Success or fail.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _default_venue_update(EE_Event $event, $data)
-    {
-        require_once(EE_MODELS . 'EEM_Venue.model.php');
-        $venue_model = EE_Registry::instance()->load_model('Venue');
-        $venue_id    = ! empty($data['venue_id']) ? $data['venue_id'] : null;
-        // very important.  If we don't have a venue name...
-        // then we'll get out because not necessary to create empty venue
-        if (empty($data['venue_title'])) {
-            return false;
-        }
-        $venue_array = [
-            'VNU_wp_user'         => $event->get('EVT_wp_user'),
-            'VNU_name'            => ! empty($data['venue_title']) ? $data['venue_title'] : null,
-            'VNU_desc'            => ! empty($data['venue_description']) ? $data['venue_description'] : null,
-            'VNU_identifier'      => ! empty($data['venue_identifier']) ? $data['venue_identifier'] : null,
-            'VNU_short_desc'      => ! empty($data['venue_short_description'])
-                ? $data['venue_short_description']
-                : null,
-            'VNU_address'         => ! empty($data['address']) ? $data['address'] : null,
-            'VNU_address2'        => ! empty($data['address2']) ? $data['address2'] : null,
-            'VNU_city'            => ! empty($data['city']) ? $data['city'] : null,
-            'STA_ID'              => ! empty($data['state']) ? $data['state'] : null,
-            'CNT_ISO'             => ! empty($data['countries']) ? $data['countries'] : null,
-            'VNU_zip'             => ! empty($data['zip']) ? $data['zip'] : null,
-            'VNU_phone'           => ! empty($data['venue_phone']) ? $data['venue_phone'] : null,
-            'VNU_capacity'        => ! empty($data['venue_capacity']) ? $data['venue_capacity'] : null,
-            'VNU_url'             => ! empty($data['venue_url']) ? $data['venue_url'] : null,
-            'VNU_virtual_phone'   => ! empty($data['virtual_phone']) ? $data['virtual_phone'] : null,
-            'VNU_virtual_url'     => ! empty($data['virtual_url']) ? $data['virtual_url'] : null,
-            'VNU_enable_for_gmap' => isset($data['enable_for_gmap']) ? 1 : 0,
-            'status'              => 'publish',
-        ];
-        // if we've got the venue_id then we're just updating the existing venue so let's do that and then get out.
-        if (! empty($venue_id)) {
-            $update_where  = [$venue_model->primary_key_name() => $venue_id];
-            $rows_affected = $venue_model->update($venue_array, [$update_where]);
-            // we've gotta make sure that the venue is always attached to a revision..
-            // add_relation_to should take care of making sure that the relation is already present.
-            $event->_add_relation_to($venue_id, 'Venue');
-            return $rows_affected > 0;
-        }
-        // we insert the venue
-        $venue_id = $venue_model->insert($venue_array);
-        $event->_add_relation_to($venue_id, 'Venue');
-        return ! empty($venue_id);
-        // when we have the ancestor come in it's already been handled by the revision save.
-    }
-
-
-    /**
-     * Handles saving everything related to Tickets (datetimes, tickets, prices)
-     *
-     * @param EE_Event $event The Event object we're attaching data to
-     * @param array    $data  The request data from the form
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws Exception
-     */
-    protected function _default_tickets_update(EE_Event $event, $data)
-    {
-        if ($this->admin_config->useAdvancedEditor()) {
-            return [];
-        }
-        $datetime       = null;
-        $saved_tickets  = [];
-        $event_timezone = $event->get_timezone();
-        $date_formats   = ['Y-m-d', 'h:i a'];
-        foreach ($data['edit_event_datetimes'] as $row => $datetime_data) {
-            // trim all values to ensure any excess whitespace is removed.
-            $datetime_data                = array_map('trim', $datetime_data);
-            $datetime_data['DTT_EVT_end'] =
-                isset($datetime_data['DTT_EVT_end']) && ! empty($datetime_data['DTT_EVT_end'])
-                    ? $datetime_data['DTT_EVT_end']
-                    : $datetime_data['DTT_EVT_start'];
-            $datetime_values              = [
-                'DTT_ID'        => ! empty($datetime_data['DTT_ID']) ? $datetime_data['DTT_ID'] : null,
-                'DTT_EVT_start' => $datetime_data['DTT_EVT_start'],
-                'DTT_EVT_end'   => $datetime_data['DTT_EVT_end'],
-                'DTT_reg_limit' => empty($datetime_data['DTT_reg_limit']) ? EE_INF : $datetime_data['DTT_reg_limit'],
-                'DTT_order'     => $row,
-            ];
-            // if we have an id then let's get existing object first and then set the new values.
-            //  Otherwise we instantiate a new object for save.
-            if (! empty($datetime_data['DTT_ID'])) {
-                $datetime = EEM_Datetime::instance($event_timezone)->get_one_by_ID($datetime_data['DTT_ID']);
-                if (! $datetime instanceof EE_Datetime) {
-                    throw new RuntimeException(
-                        sprintf(
-                            esc_html__(
-                                'Something went wrong! A valid Datetime could not be retrieved from the database using the supplied ID: %1$d',
-                                'event_espresso'
-                            ),
-                            $datetime_data['DTT_ID']
-                        )
-                    );
-                }
-                $datetime->set_date_format($date_formats[0]);
-                $datetime->set_time_format($date_formats[1]);
-                foreach ($datetime_values as $field => $value) {
-                    $datetime->set($field, $value);
-                }
-            } else {
-                $datetime = EE_Datetime::new_instance($datetime_values, $event_timezone, $date_formats);
-            }
-            if (! $datetime instanceof EE_Datetime) {
-                throw new RuntimeException(
-                    sprintf(
-                        esc_html__(
-                            'Something went wrong! A valid Datetime could not be generated or retrieved using the supplied data: %1$s',
-                            'event_espresso'
-                        ),
-                        print_r($datetime_values, true)
-                    )
-                );
-            }
-            // before going any further make sure our dates are setup correctly
-            // so that the end date is always equal or greater than the start date.
-            if ($datetime->get_raw('DTT_EVT_start') > $datetime->get_raw('DTT_EVT_end')) {
-                $datetime->set('DTT_EVT_end', $datetime->get('DTT_EVT_start'));
-                $datetime = EEH_DTT_Helper::date_time_add($datetime, 'DTT_EVT_end', 'days');
-            }
-            $datetime->save();
-            $event->_add_relation_to($datetime, 'Datetime');
-        }
-        // no datetimes get deleted so we don't do any of that logic here.
-        // update tickets next
-        $old_tickets = isset($data['ticket_IDs']) ? explode(',', $data['ticket_IDs']) : [];
-
-        // set up some default start and end dates in case those are not present in the incoming data
-        $default_start_date = new DateTime('now', new DateTimeZone($event->get_timezone()));
-        $default_start_date = $default_start_date->format($date_formats[0] . ' ' . $date_formats[1]);
-        // use the start date of the first datetime for the end date
-        $first_datetime   = $event->first_datetime();
-        $default_end_date = $first_datetime->start_date_and_time($date_formats[0], $date_formats[1]);
-
-        // now process the incoming data
-        foreach ($data['edit_tickets'] as $row => $ticket_data) {
-            $update_prices = false;
-            $ticket_price  = isset($data['edit_prices'][ $row ][1]['PRC_amount'])
-                ? $data['edit_prices'][ $row ][1]['PRC_amount']
-                : 0;
-            // trim inputs to ensure any excess whitespace is removed.
-            $ticket_data   = array_map('trim', $ticket_data);
-            $ticket_values = [
-                'TKT_ID'          => ! empty($ticket_data['TKT_ID']) ? $ticket_data['TKT_ID'] : null,
-                'TTM_ID'          => ! empty($ticket_data['TTM_ID']) ? $ticket_data['TTM_ID'] : 0,
-                'TKT_name'        => ! empty($ticket_data['TKT_name']) ? $ticket_data['TKT_name'] : '',
-                'TKT_description' => ! empty($ticket_data['TKT_description']) ? $ticket_data['TKT_description'] : '',
-                'TKT_start_date'  => ! empty($ticket_data['TKT_start_date'])
-                    ? $ticket_data['TKT_start_date']
-                    : $default_start_date,
-                'TKT_end_date'    => ! empty($ticket_data['TKT_end_date'])
-                    ? $ticket_data['TKT_end_date']
-                    : $default_end_date,
-                'TKT_qty'         => ! empty($ticket_data['TKT_qty'])
-                                     || (isset($ticket_data['TKT_qty']) && (int) $ticket_data['TKT_qty'] === 0)
-                    ? $ticket_data['TKT_qty']
-                    : EE_INF,
-                'TKT_uses'        => ! empty($ticket_data['TKT_uses'])
-                                     || (isset($ticket_data['TKT_uses']) && (int) $ticket_data['TKT_uses'] === 0)
-                    ? $ticket_data['TKT_uses']
-                    : EE_INF,
-                'TKT_min'         => ! empty($ticket_data['TKT_min']) ? $ticket_data['TKT_min'] : 0,
-                'TKT_max'         => ! empty($ticket_data['TKT_max']) ? $ticket_data['TKT_max'] : EE_INF,
-                'TKT_order'       => isset($ticket_data['TKT_order']) ? $ticket_data['TKT_order'] : $row,
-                'TKT_price'       => $ticket_price,
-                'TKT_row'         => $row,
-            ];
-            // if this is a default ticket, then we need to set the TKT_ID to 0 and update accordingly,
-            // which means in turn that the prices will become new prices as well.
-            if (isset($ticket_data['TKT_is_default']) && $ticket_data['TKT_is_default']) {
-                $ticket_values['TKT_ID']         = 0;
-                $ticket_values['TKT_is_default'] = 0;
-                $update_prices                   = true;
-            }
-            // if we have a TKT_ID then we need to get that existing TKT_obj and update it
-            // we actually do our saves ahead of adding any relations because its entirely possible that this
-            // ticket didn't get removed or added to any datetime in the session but DID have it's items modified.
-            // keep in mind that if the ticket has been sold (and we have changed pricing information),
-            // then we won't be updating the tkt but instead a new tkt will be created and the old one archived.
-            if (! empty($ticket_data['TKT_ID'])) {
-                $existing_ticket = EEM_Ticket::instance($event_timezone)->get_one_by_ID($ticket_data['TKT_ID']);
-                if (! $existing_ticket instanceof EE_Ticket) {
-                    throw new RuntimeException(
-                        sprintf(
-                            esc_html__(
-                                'Something went wrong! A valid Ticket could not be retrieved from the database using the supplied ID: %1$d',
-                                'event_espresso'
-                            ),
-                            $ticket_data['TKT_ID']
-                        )
-                    );
-                }
-                $ticket_sold = $existing_ticket->count_related(
-                    'Registration',
-                    [
-                            [
-                                'STS_ID' => [
-                                    'NOT IN',
-                                    [EEM_Registration::status_id_incomplete],
-                                ],
-                            ],
-                        ]
-                ) > 0;
-                // let's just check the total price for the existing ticket and determine if it matches the new total price.
-                // if they are different then we create a new ticket (if $ticket_sold)
-                // if they aren't different then we go ahead and modify existing ticket.
-                $create_new_ticket = $ticket_sold
-                                     && $ticket_price !== $existing_ticket->price()
-                                     && ! $existing_ticket->deleted();
-                $existing_ticket->set_date_format($date_formats[0]);
-                $existing_ticket->set_time_format($date_formats[1]);
-                // set new values
-                foreach ($ticket_values as $field => $value) {
-                    if ($field == 'TKT_qty') {
-                        $existing_ticket->set_qty($value);
-                    } elseif ($field == 'TKT_price') {
-                        $existing_ticket->set('TKT_price', $ticket_price);
-                    } else {
-                        $existing_ticket->set($field, $value);
-                    }
-                }
-                $ticket = $existing_ticket;
-                // if $create_new_ticket is false then we can safely update the existing ticket.
-                //  Otherwise we have to create a new ticket.
-                if ($create_new_ticket) {
-                    // archive the old ticket first
-                    $existing_ticket->set('TKT_deleted', 1);
-                    $existing_ticket->save();
-                    // make sure this ticket is still recorded in our $saved_tickets
-                    // so we don't run it through the regular trash routine.
-                    $saved_tickets[ $existing_ticket->ID() ] = $existing_ticket;
-                    // create new ticket that's a copy of the existing except,
-                    // (a new id of course and not archived) AND has the new TKT_price associated with it.
-                    $new_ticket = clone $existing_ticket;
-                    $new_ticket->set('TKT_ID', 0);
-                    $new_ticket->set('TKT_deleted', 0);
-                    $new_ticket->set('TKT_sold', 0);
-                    // now we need to make sure that $new prices are created as well and attached to new ticket.
-                    $update_prices = true;
-                    $ticket        = $new_ticket;
-                }
-            } else {
-                // no TKT_id so a new ticket
-                $ticket_values['TKT_price'] = $ticket_price;
-                $ticket                     = EE_Ticket::new_instance($ticket_values, $event_timezone, $date_formats);
-                $update_prices              = true;
-            }
-            if (! $ticket instanceof EE_Ticket) {
-                throw new RuntimeException(
-                    sprintf(
-                        esc_html__(
-                            'Something went wrong! A valid Ticket could not be generated or retrieved using the supplied data: %1$s',
-                            'event_espresso'
-                        ),
-                        print_r($ticket_values, true)
-                    )
-                );
-            }
-            // cap ticket qty by datetime reg limits
-            $ticket->set_qty(min($ticket->qty(), $ticket->qty('reg_limit')));
-            // update ticket.
-            $ticket->save();
-            // before going any further make sure our dates are setup correctly
-            // so that the end date is always equal or greater than the start date.
-            if ($ticket->get_raw('TKT_start_date') > $ticket->get_raw('TKT_end_date')) {
-                $ticket->set('TKT_end_date', $ticket->get('TKT_start_date'));
-                $ticket = EEH_DTT_Helper::date_time_add($ticket, 'TKT_end_date', 'days');
-                $ticket->save();
-            }
-            // initially let's add the ticket to the datetime
-            $datetime->_add_relation_to($ticket, 'Ticket');
-            $saved_tickets[ $ticket->ID() ] = $ticket;
-            // add prices to ticket
-            $prices_data = isset($data['edit_prices'][ $row ]) && is_array($data['edit_prices'][ $row ])
-                ? $data['edit_prices'][ $row ]
-                : [];
-            $this->_add_prices_to_ticket($prices_data, $ticket, $update_prices);
-        }
-        // however now we need to handle permanently deleting tickets via the ui.
-        // Keep in mind that the ui does not allow deleting/archiving tickets that have ticket sold.
-        // However, it does allow for deleting tickets that have no tickets sold,
-        // in which case we want to get rid of permanently because there is no need to save in db.
-        $old_tickets     = isset($old_tickets[0]) && $old_tickets[0] === '' ? [] : $old_tickets;
-        $tickets_removed = array_diff($old_tickets, array_keys($saved_tickets));
-        foreach ($tickets_removed as $id) {
-            $id = absint($id);
-            // get the ticket for this id
-            $ticket_to_remove = EEM_Ticket::instance()->get_one_by_ID($id);
-            if (! $ticket_to_remove instanceof EE_Ticket) {
-                continue;
-            }
-            // need to get all the related datetimes on this ticket and remove from every single one of them
-            // (remember this process can ONLY kick off if there are NO tickets sold)
-            $related_datetimes = $ticket_to_remove->get_many_related('Datetime');
-            foreach ($related_datetimes as $related_datetime) {
-                $ticket_to_remove->_remove_relation_to($related_datetime, 'Datetime');
-            }
-            // need to do the same for prices (except these prices can also be deleted because again,
-            // tickets can only be trashed if they don't have any TKTs sold (otherwise they are just archived))
-            $ticket_to_remove->delete_related_permanently('Price');
-            // finally let's delete this ticket
-            // (which should not be blocked at this point b/c we've removed all our relationships)
-            $ticket_to_remove->delete_permanently();
-        }
-        return [$datetime, $saved_tickets];
-    }
-
-
-    /**
-     * This attaches a list of given prices to a ticket.
-     * Note we dont' have to worry about ever removing relationships (or archiving prices)
-     * because if there is a change in price information on a ticket, a new ticket is created anyways
-     * so the archived ticket will retain the old price info and prices are automatically "archived" via the ticket.
-     *
-     * @access  private
-     * @param array     $prices_data Array of prices from the form.
-     * @param EE_Ticket $ticket      EE_Ticket object that prices are being attached to.
-     * @param bool      $new_prices  Whether attach existing incoming prices or create new ones.
-     * @return  void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _add_prices_to_ticket($prices_data, EE_Ticket $ticket, $new_prices = false)
-    {
-        $timezone = $ticket->get_timezone();
-        foreach ($prices_data as $row => $price_data) {
-            $price_values = [
-                'PRC_ID'         => ! empty($price_data['PRC_ID']) ? $price_data['PRC_ID'] : null,
-                'PRT_ID'         => ! empty($price_data['PRT_ID']) ? $price_data['PRT_ID'] : null,
-                'PRC_amount'     => ! empty($price_data['PRC_amount']) ? $price_data['PRC_amount'] : 0,
-                'PRC_name'       => ! empty($price_data['PRC_name']) ? $price_data['PRC_name'] : '',
-                'PRC_desc'       => ! empty($price_data['PRC_desc']) ? $price_data['PRC_desc'] : '',
-                'PRC_is_default' => 0, // make sure prices are NOT set as default from this context
-                'PRC_order'      => $row,
-            ];
-            if ($new_prices || empty($price_values['PRC_ID'])) {
-                $price_values['PRC_ID'] = 0;
-                $price                  = EE_Price::new_instance($price_values, $timezone);
-            } else {
-                $price = EEM_Price::instance($timezone)->get_one_by_ID($price_data['PRC_ID']);
-                // update this price with new values
-                foreach ($price_values as $field => $new_price) {
-                    $price->set($field, $new_price);
-                }
-            }
-            if (! $price instanceof EE_Price) {
-                throw new RuntimeException(
-                    sprintf(
-                        esc_html__(
-                            'Something went wrong! A valid Price could not be generated or retrieved using the supplied data: %1$s',
-                            'event_espresso'
-                        ),
-                        print_r($price_values, true)
-                    )
-                );
-            }
-            $price->save();
-            $ticket->_add_relation_to($price, 'Price');
-        }
-    }
-
-
-    /**
-     * Add in our autosave ajax handlers
-     *
-     */
-    protected function _ee_autosave_create_new()
-    {
-    }
-
-
-    /**
-     * More autosave handlers.
-     */
-    protected function _ee_autosave_edit()
-    {
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _generate_publish_box_extra_content()
-    {
-        // load formatter helper
-        // args for getting related registrations
-        $approved_query_args        = [
-            [
-                'REG_deleted' => 0,
-                'STS_ID'      => EEM_Registration::status_id_approved,
-            ],
-        ];
-        $not_approved_query_args    = [
-            [
-                'REG_deleted' => 0,
-                'STS_ID'      => EEM_Registration::status_id_not_approved,
-            ],
-        ];
-        $pending_payment_query_args = [
-            [
-                'REG_deleted' => 0,
-                'STS_ID'      => EEM_Registration::status_id_pending_payment,
-            ],
-        ];
-        // publish box
-        $publish_box_extra_args = [
-            'view_approved_reg_url'        => add_query_arg(
-                [
-                    'action'      => 'default',
-                    'event_id'    => $this->_cpt_model_obj->ID(),
-                    '_reg_status' => EEM_Registration::status_id_approved,
-                ],
-                REG_ADMIN_URL
-            ),
-            'view_not_approved_reg_url'    => add_query_arg(
-                [
-                    'action'      => 'default',
-                    'event_id'    => $this->_cpt_model_obj->ID(),
-                    '_reg_status' => EEM_Registration::status_id_not_approved,
-                ],
-                REG_ADMIN_URL
-            ),
-            'view_pending_payment_reg_url' => add_query_arg(
-                [
-                    'action'      => 'default',
-                    'event_id'    => $this->_cpt_model_obj->ID(),
-                    '_reg_status' => EEM_Registration::status_id_pending_payment,
-                ],
-                REG_ADMIN_URL
-            ),
-            'approved_regs'                => $this->_cpt_model_obj->count_related(
-                'Registration',
-                $approved_query_args
-            ),
-            'not_approved_regs'            => $this->_cpt_model_obj->count_related(
-                'Registration',
-                $not_approved_query_args
-            ),
-            'pending_payment_regs'         => $this->_cpt_model_obj->count_related(
-                'Registration',
-                $pending_payment_query_args
-            ),
-            'misc_pub_section_class'       => apply_filters(
-                'FHEE_Events_Admin_Page___generate_publish_box_extra_content__misc_pub_section_class',
-                'misc-pub-section'
-            ),
-        ];
-        ob_start();
-        do_action(
-            'AHEE__Events_Admin_Page___generate_publish_box_extra_content__event_editor_overview_add',
-            $this->_cpt_model_obj
-        );
-        $publish_box_extra_args['event_editor_overview_add'] = ob_get_clean();
-        // load template
-        EEH_Template::display_template(
-            EVENTS_TEMPLATE_PATH . 'event_publish_box_extras.template.php',
-            $publish_box_extra_args
-        );
-    }
-
-
-    /**
-     * @return EE_Event
-     */
-    public function get_event_object()
-    {
-        return $this->_cpt_model_obj;
-    }
-
-
-
-
-    /** METABOXES * */
-    /**
-     * _register_event_editor_meta_boxes
-     * add all metaboxes related to the event_editor
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _register_event_editor_meta_boxes()
-    {
-        $this->verify_cpt_object();
-        $use_advanced_editor = $this->admin_config->useAdvancedEditor();
-        // check if the new EDTR reg options meta box is being used, and if so, don't load the legacy version
-        if (! $use_advanced_editor || ! $this->feature->allowed('use_reg_options_meta_box')) {
-            $this->addMetaBox(
-                'espresso_event_editor_event_options',
-                esc_html__('Event Registration Options', 'event_espresso'),
-                [$this, 'registration_options_meta_box'],
-                $this->page_slug,
-                'side'
-            );
-        }
-        if (! $use_advanced_editor) {
-            $this->addMetaBox(
-                'espresso_event_editor_tickets',
-                esc_html__('Event Datetime & Ticket', 'event_espresso'),
-                [$this, 'ticket_metabox'],
-                $this->page_slug,
-                'normal',
-                'high'
-            );
-        } elseif ($this->feature->allowed('use_reg_options_meta_box')) {
-            add_action(
-                'add_meta_boxes_espresso_events',
-                function () {
-                    global $current_screen;
-                    remove_meta_box('authordiv', $current_screen, 'normal');
-                },
-                99
-            );
-        }
-        // NOTE: if you're looking for other metaboxes in here,
-        // where a metabox has a related management page in the admin
-        // you will find it setup in the related management page's "_Hooks" file.
-        // i.e. messages metabox is found in "espresso_events_Messages_Hooks.class.php".
-    }
-
-
-    /**
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function ticket_metabox()
-    {
-        $existing_datetime_ids = $existing_ticket_ids = [];
-        // defaults for template args
-        $template_args = [
-            'existing_datetime_ids'    => '',
-            'event_datetime_help_link' => '',
-            'ticket_options_help_link' => '',
-            'time'                     => null,
-            'ticket_rows'              => '',
-            'existing_ticket_ids'      => '',
-            'total_ticket_rows'        => 1,
-            'ticket_js_structure'      => '',
-            'trash_icon'               => 'dashicons dashicons-lock',
-            'disabled'                 => '',
-        ];
-        $event_id      = is_object($this->_cpt_model_obj) ? $this->_cpt_model_obj->ID() : null;
-        /**
-         * 1. Start with retrieving Datetimes
-         * 2. Fore each datetime get related tickets
-         * 3. For each ticket get related prices
-         */
-        /** @var EEM_Datetime $datetime_model */
-        $datetime_model = EE_Registry::instance()->load_model('Datetime');
-        /** @var EEM_Ticket $datetime_model */
-        $ticket_model = EE_Registry::instance()->load_model('Ticket');
-        $times        = $datetime_model->get_all_event_dates($event_id);
-        /** @type EE_Datetime $first_datetime */
-        $first_datetime = reset($times);
-        // do we get related tickets?
-        if (
-            $first_datetime instanceof EE_Datetime
-            && $first_datetime->ID() !== 0
-        ) {
-            $existing_datetime_ids[] = $first_datetime->get('DTT_ID');
-            $template_args['time']   = $first_datetime;
-            $related_tickets         = $first_datetime->tickets(
-                [
-                    ['OR' => ['TKT_deleted' => 1, 'TKT_deleted*' => 0]],
-                    'default_where_conditions' => 'none',
-                ]
-            );
-            if (! empty($related_tickets)) {
-                $template_args['total_ticket_rows'] = count($related_tickets);
-                $row                                = 0;
-                foreach ($related_tickets as $ticket) {
-                    $existing_ticket_ids[]        = $ticket->get('TKT_ID');
-                    $template_args['ticket_rows'] .= $this->_get_ticket_row($ticket, false, $row);
-                    $row++;
-                }
-            } else {
-                $template_args['total_ticket_rows'] = 1;
-                /** @type EE_Ticket $ticket */
-                $ticket                       = $ticket_model->create_default_object();
-                $template_args['ticket_rows'] .= $this->_get_ticket_row($ticket);
-            }
-        } else {
-            $template_args['time'] = $times[0];
-            /** @type EE_Ticket[] $tickets */
-            $tickets                      = $ticket_model->get_all_default_tickets();
-            $template_args['ticket_rows'] .= $this->_get_ticket_row($tickets[1]);
-            // NOTE: we're just sending the first default row
-            // (decaf can't manage default tickets so this should be sufficient);
-        }
-        $template_args['event_datetime_help_link'] = $this->_get_help_tab_link(
-            'event_editor_event_datetimes_help_tab'
-        );
-        $template_args['ticket_options_help_link'] = $this->_get_help_tab_link('ticket_options_info');
-        $template_args['existing_datetime_ids']    = implode(',', $existing_datetime_ids);
-        $template_args['existing_ticket_ids']      = implode(',', $existing_ticket_ids);
-        $template_args['ticket_js_structure']      = $this->_get_ticket_row(
-            $ticket_model->create_default_object(),
-            true
-        );
-        $template                                  = apply_filters(
-            'FHEE__Events_Admin_Page__ticket_metabox__template',
-            EVENTS_TEMPLATE_PATH . 'event_tickets_metabox_main.template.php'
-        );
-        EEH_Template::display_template($template, $template_args);
-    }
-
-
-    /**
-     * Setup an individual ticket form for the decaf event editor page
-     *
-     * @access private
-     * @param EE_Ticket $ticket   the ticket object
-     * @param boolean   $skeleton whether we're generating a skeleton for js manipulation
-     * @param int       $row
-     * @return string generated html for the ticket row.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _get_ticket_row($ticket, $skeleton = false, $row = 0)
-    {
-        $template_args = [
-            'tkt_status_class'    => ' tkt-status-' . $ticket->ticket_status(),
-            'tkt_archive_class'   => $ticket->ticket_status() === EE_Ticket::archived && ! $skeleton ? ' tkt-archived'
-                : '',
-            'ticketrow'           => $skeleton ? 'TICKETNUM' : $row,
-            'TKT_ID'              => $ticket->get('TKT_ID'),
-            'TKT_name'            => $ticket->get('TKT_name'),
-            'TKT_start_date'      => $skeleton ? '' : $ticket->get_date('TKT_start_date', 'Y-m-d h:i a'),
-            'TKT_end_date'        => $skeleton ? '' : $ticket->get_date('TKT_end_date', 'Y-m-d h:i a'),
-            'TKT_is_default'      => $ticket->get('TKT_is_default'),
-            'TKT_qty'             => $ticket->get_pretty('TKT_qty', 'input'),
-            'edit_ticketrow_name' => $skeleton ? 'TICKETNAMEATTR' : 'edit_tickets',
-            'TKT_sold'            => $skeleton ? 0 : $ticket->get('TKT_sold'),
-            'trash_icon'          => ($skeleton || (! empty($ticket) && ! $ticket->get('TKT_deleted')))
-                                     && (! empty($ticket) && $ticket->get('TKT_sold') === 0)
-                ? 'trash-icon dashicons dashicons-post-trash clickable' : 'dashicons dashicons-lock',
-            'disabled'            => $skeleton || (! empty($ticket) && ! $ticket->get('TKT_deleted')) ? ''
-                : ' disabled=disabled',
-        ];
-        $price         = $ticket->ID() !== 0
-            ? $ticket->get_first_related('Price', ['default_where_conditions' => 'none'])
-            : null;
-        $price         = $price instanceof EE_Price
-            ? $price
-            : EEM_Price::instance()->create_default_object();
-        $price_args    = [
-            'price_currency_symbol' => EE_Registry::instance()->CFG->currency->sign,
-            'PRC_amount'            => $price->get('PRC_amount'),
-            'PRT_ID'                => $price->get('PRT_ID'),
-            'PRC_ID'                => $price->get('PRC_ID'),
-            'PRC_is_default'        => $price->get('PRC_is_default'),
-        ];
-        // make sure we have default start and end dates if skeleton
-        // handle rows that should NOT be empty
-        if (empty($template_args['TKT_start_date'])) {
-            // if empty then the start date will be now.
-            $template_args['TKT_start_date'] = date('Y-m-d h:i a', current_time('timestamp'));
-        }
-        if (empty($template_args['TKT_end_date'])) {
-            // get the earliest datetime (if present);
-            $earliest_datetime             = $this->_cpt_model_obj->ID() > 0
-                ? $this->_cpt_model_obj->get_first_related(
-                    'Datetime',
-                    ['order_by' => ['DTT_EVT_start' => 'ASC']]
-                )
-                : null;
-            $template_args['TKT_end_date'] = $earliest_datetime instanceof EE_Datetime
-                ? $earliest_datetime->get_datetime('DTT_EVT_start', 'Y-m-d', 'h:i a')
-                : date('Y-m-d h:i a', mktime(0, 0, 0, date('m'), date('d') + 7, date('Y')));
-        }
-        $template_args = array_merge($template_args, $price_args);
-        $template      = apply_filters(
-            'FHEE__Events_Admin_Page__get_ticket_row__template',
-            EVENTS_TEMPLATE_PATH . 'event_tickets_metabox_ticket_row.template.php',
-            $ticket
-        );
-        return EEH_Template::display_template($template, $template_args, true);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function registration_options_meta_box()
-    {
-        $yes_no_values             = [
-            ['id' => true, 'text' => esc_html__('Yes', 'event_espresso')],
-            ['id' => false, 'text' => esc_html__('No', 'event_espresso')],
-        ];
-        $default_reg_status_values = EEM_Registration::reg_status_array(
-            [
-                EEM_Registration::status_id_cancelled,
-                EEM_Registration::status_id_declined,
-                EEM_Registration::status_id_incomplete,
-            ],
-            true
-        );
-        // $template_args['is_active_select'] = EEH_Form_Fields::select_input('is_active', $yes_no_values, $this->_cpt_model_obj->is_active());
-        $template_args['_event']                          = $this->_cpt_model_obj;
-        $template_args['event']                           = $this->_cpt_model_obj;
-        $template_args['active_status']                   = $this->_cpt_model_obj->pretty_active_status(false);
-        $template_args['additional_limit']                = $this->_cpt_model_obj->additional_limit();
-        $template_args['default_registration_status']     = EEH_Form_Fields::select_input(
-            'default_reg_status',
-            $default_reg_status_values,
-            $this->_cpt_model_obj->default_registration_status()
-        );
-        $template_args['display_description']             = EEH_Form_Fields::select_input(
-            'display_desc',
-            $yes_no_values,
-            $this->_cpt_model_obj->display_description()
-        );
-        $template_args['display_ticket_selector']         = EEH_Form_Fields::select_input(
-            'display_ticket_selector',
-            $yes_no_values,
-            $this->_cpt_model_obj->display_ticket_selector(),
-            '',
-            '',
-            false
-        );
-        $template_args['additional_registration_options'] = apply_filters(
-            'FHEE__Events_Admin_Page__registration_options_meta_box__additional_registration_options',
-            '',
-            $template_args,
-            $yes_no_values,
-            $default_reg_status_values
-        );
-        EEH_Template::display_template(
-            EVENTS_TEMPLATE_PATH . 'event_registration_options.template.php',
-            $template_args
-        );
-    }
-
-
-    /**
-     * _get_events()
-     * This method simply returns all the events (for the given _view and paging)
-     *
-     * @access public
-     * @param int  $per_page     count of items per page (20 default);
-     * @param int  $current_page what is the current page being viewed.
-     * @param bool $count        if TRUE then we just return a count of ALL events matching the given _view.
-     *                           If FALSE then we return an array of event objects
-     *                           that match the given _view and paging parameters.
-     * @return array|int         an array of event objects or a count of them.
-     * @throws Exception
-     */
-    public function get_events($per_page = 10, $current_page = 1, $count = false)
-    {
-        $EEM_Event   = $this->_event_model();
-        $offset      = ($current_page - 1) * $per_page;
-        $limit       = $count ? null : $offset . ',' . $per_page;
-        $orderby     = $this->request->getRequestParam('orderby', 'EVT_ID');
-        $order       = $this->request->getRequestParam('order', 'DESC');
-        $month_range = $this->request->getRequestParam('month_range');
-        if ($month_range) {
-            $pieces = explode(' ', $month_range, 3);
-            // simulate the FIRST day of the month, that fixes issues for months like February
-            // where PHP doesn't know what to assume for date.
-            // @see https://events.codebasehq.com/projects/event-espresso/tickets/10437
-            $month_r = ! empty($pieces[0]) ? date('m', EEH_DTT_Helper::first_of_month_timestamp($pieces[0])) : '';
-            $year_r  = ! empty($pieces[1]) ? $pieces[1] : '';
-        }
-        $where  = [];
-        $status = $this->request->getRequestParam('status');
-        // determine what post_status our condition will have for the query.
-        switch ($status) {
-            case 'month':
-            case 'today':
-            case null:
-            case 'all':
-                break;
-            case 'draft':
-                $where['status'] = ['IN', ['draft', 'auto-draft']];
-                break;
-            default:
-                $where['status'] = $status;
-        }
-        // categories? The default for all categories is -1
-        $category = $this->request->getRequestParam('EVT_CAT', -1, 'int');
-        if ($category !== -1) {
-            $where['Term_Taxonomy.taxonomy'] = EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY;
-            $where['Term_Taxonomy.term_id']  = $category;
-        }
-        // date where conditions
-        $start_formats = EEM_Datetime::instance()->get_formats_for('DTT_EVT_start');
-        if ($month_range) {
-            $DateTime = new DateTime(
-                $year_r . '-' . $month_r . '-01 00:00:00',
-                new DateTimeZone('UTC')
-            );
-            $start    = $DateTime->getTimestamp();
-            // set the datetime to be the end of the month
-            $DateTime->setDate(
-                $year_r,
-                $month_r,
-                $DateTime->format('t')
-            )->setTime(23, 59, 59);
-            $end                             = $DateTime->getTimestamp();
-            $where['Datetime.DTT_EVT_start'] = ['BETWEEN', [$start, $end]];
-        } elseif ($status === 'today') {
-            $DateTime                        =
-                new DateTime('now', new DateTimeZone(EEM_Event::instance()->get_timezone()));
-            $start                           = $DateTime->setTime(0, 0)->format(implode(' ', $start_formats));
-            $end                             = $DateTime->setTime(23, 59, 59)->format(implode(' ', $start_formats));
-            $where['Datetime.DTT_EVT_start'] = ['BETWEEN', [$start, $end]];
-        } elseif ($status === 'month') {
-            $now                             = date('Y-m-01');
-            $DateTime                        =
-                new DateTime($now, new DateTimeZone(EEM_Event::instance()->get_timezone()));
-            $start                           = $DateTime->setTime(0, 0)->format(implode(' ', $start_formats));
-            $end                             = $DateTime->setDate(date('Y'), date('m'), $DateTime->format('t'))
-                                                        ->setTime(23, 59, 59)
-                                                        ->format(implode(' ', $start_formats));
-            $where['Datetime.DTT_EVT_start'] = ['BETWEEN', [$start, $end]];
-        }
-        if (! EE_Registry::instance()->CAP->current_user_can('ee_read_others_events', 'get_events')) {
-            $where['EVT_wp_user'] = get_current_user_id();
-        } else {
-            if (! isset($where['status'])) {
-                if (! EE_Registry::instance()->CAP->current_user_can('ee_read_private_events', 'get_events')) {
-                    $where['OR'] = [
-                        'status*restrict_private' => ['!=', 'private'],
-                        'AND'                     => [
-                            'status*inclusive' => ['=', 'private'],
-                            'EVT_wp_user'      => get_current_user_id(),
-                        ],
-                    ];
-                }
-            }
-        }
-        $wp_user = $this->request->getRequestParam('EVT_wp_user', 0, 'int');
-        if (
-            $wp_user
-            && $wp_user !== get_current_user_id()
-            && EE_Registry::instance()->CAP->current_user_can('ee_read_others_events', 'get_events')
-        ) {
-            $where['EVT_wp_user'] = $wp_user;
-        }
-        // search query handling
-        $search_term = $this->request->getRequestParam('s');
-        if ($search_term) {
-            $search_term = '%' . $search_term . '%';
-            $where['OR'] = [
-                'EVT_name'       => ['LIKE', $search_term],
-                'EVT_desc'       => ['LIKE', $search_term],
-                'EVT_short_desc' => ['LIKE', $search_term],
-            ];
-        }
-        // filter events by venue.
-        $venue = $this->request->getRequestParam('venue', 0, 'int');
-        if ($venue) {
-            $where['Venue.VNU_ID'] = $venue;
-        }
-        $request_params = $this->request->requestParams();
-        $where          = apply_filters('FHEE__Events_Admin_Page__get_events__where', $where, $request_params);
-        $query_params   = apply_filters(
-            'FHEE__Events_Admin_Page__get_events__query_params',
-            [
-                $where,
-                'limit'    => $limit,
-                'order_by' => $orderby,
-                'order'    => $order,
-                'group_by' => 'EVT_ID',
-            ],
-            $request_params
-        );
-
-        // let's first check if we have special requests coming in.
-        $active_status = $this->request->getRequestParam('active_status');
-        if ($active_status) {
-            switch ($active_status) {
-                case 'upcoming':
-                    return $EEM_Event->get_upcoming_events($query_params, $count);
-                case 'expired':
-                    return $EEM_Event->get_expired_events($query_params, $count);
-                case 'active':
-                    return $EEM_Event->get_active_events($query_params, $count);
-                case 'inactive':
-                    return $EEM_Event->get_inactive_events($query_params, $count);
-            }
-        }
-
-        return $count ? $EEM_Event->count([$where], 'EVT_ID', true) : $EEM_Event->get_all($query_params);
-    }
-
-
-    /**
-     * handling for WordPress CPT actions (trash, restore, delete)
-     *
-     * @param string $post_id
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function trash_cpt_item($post_id)
-    {
-        $this->request->setRequestParam('EVT_ID', $post_id);
-        $this->_trash_or_restore_event('trash', false);
-    }
-
-
-    /**
-     * @param string $post_id
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function restore_cpt_item($post_id)
-    {
-        $this->request->setRequestParam('EVT_ID', $post_id);
-        $this->_trash_or_restore_event('draft', false);
-    }
-
-
-    /**
-     * @param string $post_id
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function delete_cpt_item($post_id)
-    {
-        throw new EE_Error(
-            esc_html__(
-                'Please contact Event Espresso support with the details of the steps taken to produce this error.',
-                'event_espresso'
-            )
-        );
-        // $this->request->setRequestParam('EVT_ID', $post_id);
-        // $this->_delete_event();
-    }
-
-
-    /**
-     * _trash_or_restore_event
-     *
-     * @access protected
-     * @param string $event_status
-     * @param bool   $redirect_after
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _trash_or_restore_event($event_status = 'trash', $redirect_after = true)
-    {
-        // determine the event id and set to array.
-        $EVT_ID = $this->request->getRequestParam('EVT_ID', 0, 'int');
-        // loop thru events
-        if ($EVT_ID) {
-            // clean status
-            $event_status = sanitize_key($event_status);
-            // grab status
-            if (! empty($event_status)) {
-                $success = $this->_change_event_status($EVT_ID, $event_status);
-            } else {
-                $success = false;
-                $msg     = esc_html__(
-                    'An error occurred. The event could not be moved to the trash because a valid event status was not not supplied.',
-                    'event_espresso'
-                );
-                EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            }
-        } else {
-            $success = false;
-            $msg     = esc_html__(
-                'An error occurred. The event could not be moved to the trash because a valid event ID was not not supplied.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-        $action = $event_status === 'trash' ? 'moved to the trash' : 'restored from the trash';
-        if ($redirect_after) {
-            $this->_redirect_after_action($success, 'Event', $action, ['action' => 'default']);
-        }
-    }
-
-
-    /**
-     * _trash_or_restore_events
-     *
-     * @access protected
-     * @param string $event_status
-     * @return void
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _trash_or_restore_events($event_status = 'trash')
-    {
-        // clean status
-        $event_status = sanitize_key($event_status);
-        // grab status
-        if (! empty($event_status)) {
-            $success = true;
-            // determine the event id and set to array.
-            $EVT_IDs = $this->request->getRequestParam('EVT_IDs', [], 'int', true);
-            // loop thru events
-            foreach ($EVT_IDs as $EVT_ID) {
-                if ($EVT_ID = absint($EVT_ID)) {
-                    $results = $this->_change_event_status($EVT_ID, $event_status);
-                    $success = $results !== false ? $success : false;
-                } else {
-                    $msg = sprintf(
-                        esc_html__(
-                            'An error occurred. Event #%d could not be moved to the trash because a valid event ID was not not supplied.',
-                            'event_espresso'
-                        ),
-                        $EVT_ID
-                    );
-                    EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-                    $success = false;
-                }
-            }
-        } else {
-            $success = false;
-            $msg     = esc_html__(
-                'An error occurred. The event could not be moved to the trash because a valid event status was not not supplied.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-        // in order to force a pluralized result message we need to send back a success status greater than 1
-        $success = $success ? 2 : false;
-        $action  = $event_status === 'trash' ? 'moved to the trash' : 'restored from the trash';
-        $this->_redirect_after_action($success, 'Events', $action, ['action' => 'default']);
-    }
-
-
-    /**
-     * @param int    $EVT_ID
-     * @param string $event_status
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _change_event_status($EVT_ID = 0, $event_status = '')
-    {
-        // grab event id
-        if (! $EVT_ID) {
-            $msg = esc_html__(
-                'An error occurred. No Event ID or an invalid Event ID was received.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        $this->_cpt_model_obj = EEM_Event::instance()->get_one_by_ID($EVT_ID);
-        // clean status
-        $event_status = sanitize_key($event_status);
-        // grab status
-        if (empty($event_status)) {
-            $msg = esc_html__(
-                'An error occurred. No Event Status or an invalid Event Status was received.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // was event trashed or restored ?
-        switch ($event_status) {
-            case 'draft':
-                $action = 'restored from the trash';
-                $hook   = 'AHEE_event_restored_from_trash';
-                break;
-            case 'trash':
-                $action = 'moved to the trash';
-                $hook   = 'AHEE_event_moved_to_trash';
-                break;
-            default:
-                $action = 'updated';
-                $hook   = false;
-        }
-        // use class to change status
-        $this->_cpt_model_obj->set_status($event_status);
-        $success = $this->_cpt_model_obj->save();
-        if (! $success) {
-            $msg = sprintf(esc_html__('An error occurred. The event could not be %s.', 'event_espresso'), $action);
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        if ($hook) {
-            do_action($hook);
-        }
-        return true;
-    }
-
-
-    /**
-     * @param array $event_ids
-     * @return array
-     * @since   4.10.23.p
-     */
-    private function cleanEventIds(array $event_ids)
-    {
-        return array_map('absint', $event_ids);
-    }
-
-
-    /**
-     * @return array
-     * @since   4.10.23.p
-     */
-    private function getEventIdsFromRequest()
-    {
-        if ($this->request->requestParamIsSet('EVT_IDs')) {
-            return $this->request->getRequestParam('EVT_IDs', [], 'int', true);
-        } else {
-            return $this->request->getRequestParam('EVT_ID', [], 'int', true);
-        }
-    }
-
-
-    /**
-     * @param bool $preview_delete
-     * @throws EE_Error
-     */
-    protected function _delete_event($preview_delete = true)
-    {
-        $this->_delete_events($preview_delete);
-    }
-
-
-    /**
-     * Gets the tree traversal batch persister.
-     *
-     * @return NodeGroupDao
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @since 4.10.12.p
-     */
-    protected function getModelObjNodeGroupPersister()
-    {
-        if (! $this->model_obj_node_group_persister instanceof NodeGroupDao) {
-            $this->model_obj_node_group_persister =
-                $this->getLoader()->load('\EventEspresso\core\services\orm\tree_traversal\NodeGroupDao');
-        }
-        return $this->model_obj_node_group_persister;
-    }
-
-
-    /**
-     * @param bool $preview_delete
-     * @return void
-     * @throws EE_Error
-     */
-    protected function _delete_events($preview_delete = true)
-    {
-        $event_ids = $this->getEventIdsFromRequest();
-        if ($preview_delete) {
-            $this->generateDeletionPreview($event_ids);
-        } else {
-            EEM_Event::instance()->delete_permanently([['EVT_ID' => ['IN', $event_ids]]]);
-        }
-    }
-
-
-    /**
-     * @param array $event_ids
-     */
-    protected function generateDeletionPreview(array $event_ids)
-    {
-        $event_ids = $this->cleanEventIds($event_ids);
-        // Set a code we can use to reference this deletion task in the batch jobs and preview page.
-        $deletion_job_code = $this->getModelObjNodeGroupPersister()->generateGroupCode();
-        $return_url        = EE_Admin_Page::add_query_args_and_nonce(
-            [
-                'action'            => 'preview_deletion',
-                'deletion_job_code' => $deletion_job_code,
-            ],
-            $this->_admin_base_url
-        );
-        EEH_URL::safeRedirectAndExit(
-            EE_Admin_Page::add_query_args_and_nonce(
-                [
-                    'page'              => EED_Batch::PAGE_SLUG,
-                    'batch'             => EED_Batch::batch_job,
-                    'EVT_IDs'           => $event_ids,
-                    'deletion_job_code' => $deletion_job_code,
-                    'job_handler'       => urlencode('EventEspressoBatchRequest\JobHandlers\PreviewEventDeletion'),
-                    'return_url'        => urlencode($return_url),
-                ],
-                admin_url()
-            )
-        );
-    }
-
-
-    /**
-     * Checks for a POST submission
-     *
-     * @since 4.10.12.p
-     */
-    protected function confirmDeletion()
-    {
-        $deletion_redirect_logic =
-            $this->getLoader()->getShared('\EventEspresso\core\domain\services\admin\events\data\ConfirmDeletion');
-        $deletion_redirect_logic->handle($this->get_request_data(), $this->admin_base_url());
-    }
-
-
-    /**
-     * A page for users to preview what exactly will be deleted, and confirm they want to delete it.
-     *
-     * @throws EE_Error
-     * @since 4.10.12.p
-     */
-    protected function previewDeletion()
-    {
-        $preview_deletion_logic =
-            $this->getLoader()->getShared('\EventEspresso\core\domain\services\admin\events\data\PreviewDeletion');
-        $this->set_template_args($preview_deletion_logic->handle($this->get_request_data(), $this->admin_base_url()));
-        $this->display_admin_page_with_no_sidebar();
-    }
-
-
-    /**
-     * get total number of events
-     *
-     * @access public
-     * @return int
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function total_events()
-    {
-        return EEM_Event::instance()->count(
-            ['caps' => 'read_admin'],
-            'EVT_ID',
-            true
-        );
-    }
-
-
-    /**
-     * get total number of draft events
-     *
-     * @access public
-     * @return int
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function total_events_draft()
-    {
-        return EEM_Event::instance()->count(
-            [
-                ['status' => ['IN', ['draft', 'auto-draft']]],
-                'caps' => 'read_admin',
-            ],
-            'EVT_ID',
-            true
-        );
-    }
-
-
-    /**
-     * get total number of trashed events
-     *
-     * @access public
-     * @return int
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function total_trashed_events()
-    {
-        return EEM_Event::instance()->count(
-            [
-                ['status' => 'trash'],
-                'caps' => 'read_admin',
-            ],
-            'EVT_ID',
-            true
-        );
-    }
-
-
-    /**
-     *    _default_event_settings
-     *    This generates the Default Settings Tab
-     *
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _default_event_settings()
-    {
-        $this->_set_add_edit_form_tags('update_default_event_settings');
-        $this->_set_publish_post_box_vars(null, false, false, null, false);
-        $this->_template_args['admin_page_content'] = EEH_HTML::div(
-            $this->_default_event_settings_form()->get_html(),
-            '',
-            'padding'
-        );
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * Return the form for event settings.
-     *
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     */
-    protected function _default_event_settings_form()
-    {
-        $registration_config              = EE_Registry::instance()->CFG->registration;
-        $registration_stati_for_selection = EEM_Registration::reg_status_array(
-        // exclude
-            [
-                EEM_Registration::status_id_cancelled,
-                EEM_Registration::status_id_declined,
-                EEM_Registration::status_id_incomplete,
-                EEM_Registration::status_id_wait_list,
-            ],
-            true
-        );
-        // setup Advanced Editor ???
-        if (
-            $this->raw_req_action === 'default_event_settings'
-            || $this->raw_req_action === 'update_default_event_settings'
-        ) {
-            $this->advanced_editor_admin_form = $this->loader->getShared(AdvancedEditorAdminFormSection::class);
-        }
-        return new EE_Form_Section_Proper(
-            [
-                'name'            => 'update_default_event_settings',
-                'html_id'         => 'update_default_event_settings',
-                'html_class'      => 'form-table',
-                'layout_strategy' => new EE_Admin_Two_Column_Layout(),
-                'subsections'     => apply_filters(
-                    'FHEE__Events_Admin_Page___default_event_settings_form__form_subsections',
-                    [
-                        'defaults_section_header' => new EE_Form_Section_HTML(
-                            EEH_HTML::h2(
-                                esc_html__('Default Settings', 'event_espresso'),
-                                '',
-                                'ee-admin-settings-hdr'
-                            )
-                        ),
-                        'default_reg_status'  => new EE_Select_Input(
-                            $registration_stati_for_selection,
-                            [
-                                'default'         => isset($registration_config->default_STS_ID)
-                                                     && array_key_exists(
-                                                         $registration_config->default_STS_ID,
-                                                         $registration_stati_for_selection
-                                                     )
-                                    ? sanitize_text_field($registration_config->default_STS_ID)
-                                    : EEM_Registration::status_id_pending_payment,
-                                'html_label_text' => esc_html__('Default Registration Status', 'event_espresso')
-                                                     . EEH_Template::get_help_tab_link(
-                                                         'default_settings_status_help_tab'
-                                                     ),
-                                'html_help_text'  => esc_html__(
-                                    'This setting allows you to preselect what the default registration status setting is when creating an event.  Note that changing this setting does NOT retroactively apply it to existing events.',
-                                    'event_espresso'
-                                ),
-                            ]
-                        ),
-                        'default_max_tickets' => new EE_Integer_Input(
-                            [
-                                'default'         => isset($registration_config->default_maximum_number_of_tickets)
-                                    ? $registration_config->default_maximum_number_of_tickets
-                                    : EEM_Event::get_default_additional_limit(),
-                                'html_label_text' => esc_html__(
-                                    'Default Maximum Tickets Allowed Per Order:',
-                                    'event_espresso'
-                                )
-                                                     . EEH_Template::get_help_tab_link(
-                                                         'default_maximum_tickets_help_tab"'
-                                                     ),
-                                'html_help_text'  => esc_html__(
-                                    'This setting allows you to indicate what will be the default for the maximum number of tickets per order when creating new events.',
-                                    'event_espresso'
-                                ),
-                            ]
-                        ),
-                    ]
-                ),
-            ]
-        );
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _update_default_event_settings()
-    {
-        $form = $this->_default_event_settings_form();
-        if ($form->was_submitted()) {
-            $form->receive_form_submission();
-            if ($form->is_valid()) {
-                $registration_config = EE_Registry::instance()->CFG->registration;
-                $valid_data          = $form->valid_data();
-                if (isset($valid_data['default_reg_status'])) {
-                    $registration_config->default_STS_ID = $valid_data['default_reg_status'];
-                }
-                if (isset($valid_data['default_max_tickets'])) {
-                    $registration_config->default_maximum_number_of_tickets = $valid_data['default_max_tickets'];
-                }
-                do_action(
-                    'AHEE__Events_Admin_Page___update_default_event_settings',
-                    $valid_data,
-                    EE_Registry::instance()->CFG,
-                    $this
-                );
-                // update because data was valid!
-                EE_Registry::instance()->CFG->update_espresso_config();
-                EE_Error::overwrite_success();
-                EE_Error::add_success(
-                    esc_html__('Default Event Settings were updated', 'event_espresso')
-                );
-            }
-        }
-        $this->_redirect_after_action(0, '', '', ['action' => 'default_event_settings'], true);
-    }
-
-
-    /*************        Templates        *************
-     *
-     * @throws EE_Error
-     */
-    protected function _template_settings()
-    {
-        $this->_admin_page_title              = esc_html__('Template Settings (Preview)', 'event_espresso');
-        $this->_template_args['preview_img']  = '<img src="'
-                                                . EVENTS_ASSETS_URL
-                                                . '/images/'
-                                                . 'caffeinated_template_features.jpg" alt="'
-                                                . esc_attr__('Template Settings Preview screenshot', 'event_espresso')
-                                                . '" />';
-        $this->_template_args['preview_text'] = '<strong>'
-                                                . esc_html__(
-                                                    'Template Settings is a feature that is only available in the premium version of Event Espresso 4 which is available with a support license purchase on EventEspresso.com. Template Settings allow you to configure some of the appearance options for both the Event List and Event Details pages.',
-                                                    'event_espresso'
-                                                ) . '</strong>';
-        $this->display_admin_caf_preview_page('template_settings_tab');
-    }
-
-
-    /** Event Category Stuff **/
-    /**
-     * set the _category property with the category object for the loaded page.
-     *
-     * @access private
-     * @return void
-     */
-    private function _set_category_object()
-    {
-        if (isset($this->_category->id) && ! empty($this->_category->id)) {
-            return;
-        } //already have the category object so get out.
-        // set default category object
-        $this->_set_empty_category_object();
-        // only set if we've got an id
-        $category_ID = $this->request->getRequestParam('EVT_CAT_ID', 0, 'int');
-        if (! $category_ID) {
-            return;
-        }
-        $term = get_term($category_ID, EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY);
-        if (! empty($term)) {
-            $this->_category->category_name       = $term->name;
-            $this->_category->category_identifier = $term->slug;
-            $this->_category->category_desc       = $term->description;
-            $this->_category->id                  = $term->term_id;
-            $this->_category->parent              = $term->parent;
-        }
-    }
-
-
-    /**
-     * Clears out category properties.
-     */
-    private function _set_empty_category_object()
-    {
-        $this->_category                = new stdClass();
-        $this->_category->category_name = $this->_category->category_identifier = $this->_category->category_desc = '';
-        $this->_category->id            = $this->_category->parent = 0;
-    }
-
-
-    /**
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _category_list_table()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $this->_search_btn_label = esc_html__('Categories', 'event_espresso');
-        $this->_admin_page_title .= ' ';
-        $this->_admin_page_title .= $this->get_action_link_or_button(
-            'add_category',
-            'add_category',
-            [],
-            'add-new-h2'
-        );
-        $this->display_admin_list_table_page_with_sidebar();
-    }
-
-
-    /**
-     * Output category details view.
-     *
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    protected function _category_details($view)
-    {
-        // load formatter helper
-        // load field generator helper
-        $route = $view === 'edit' ? 'update_category' : 'insert_category';
-        $this->_set_add_edit_form_tags($route);
-        $this->_set_category_object();
-        $id            = ! empty($this->_category->id) ? $this->_category->id : '';
-        $delete_action = 'delete_category';
-        // custom redirect
-        $redirect = EE_Admin_Page::add_query_args_and_nonce(
-            ['action' => 'category_list'],
-            $this->_admin_base_url
-        );
-        $this->_set_publish_post_box_vars('EVT_CAT_ID', $id, $delete_action, $redirect);
-        // take care of contents
-        $this->_template_args['admin_page_content'] = $this->_category_details_content();
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * Output category details content.
-     *
-     * @throws DomainException
-     */
-    protected function _category_details_content()
-    {
-        $editor_args['category_desc'] = [
-            'type'          => 'wp_editor',
-            'value'         => EEH_Formatter::admin_format_content($this->_category->category_desc),
-            'class'         => 'my_editor_custom',
-            'wpeditor_args' => ['media_buttons' => false],
-        ];
-        $_wp_editor                   = $this->_generate_admin_form_fields($editor_args, 'array');
-        $all_terms                    = get_terms(
-            [EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY],
-            ['hide_empty' => 0, 'exclude' => [$this->_category->id]]
-        );
-        // setup category select for term parents.
-        $category_select_values[] = [
-            'text' => esc_html__('No Parent', 'event_espresso'),
-            'id'   => 0,
-        ];
-        foreach ($all_terms as $term) {
-            $category_select_values[] = [
-                'text' => $term->name,
-                'id'   => $term->term_id,
-            ];
-        }
-        $category_select = EEH_Form_Fields::select_input(
-            'category_parent',
-            $category_select_values,
-            $this->_category->parent
-        );
-        $template_args   = [
-            'category'                 => $this->_category,
-            'category_select'          => $category_select,
-            'unique_id_info_help_link' => $this->_get_help_tab_link('unique_id_info'),
-            'category_desc_editor'     => $_wp_editor['category_desc']['field'],
-            'disable'                  => '',
-            'disabled_message'         => false,
-        ];
-        $template        = EVENTS_TEMPLATE_PATH . 'event_category_details.template.php';
-        return EEH_Template::display_template($template, $template_args, true);
-    }
-
-
-    /**
-     * Handles deleting categories.
-     *
-     * @throws EE_Error
-     */
-    protected function _delete_categories()
-    {
-        $category_IDs = $this->request->getRequestParam('EVT_CAT_ID', 0, 'int', true);
-        foreach ($category_IDs as $category_ID) {
-            $this->_delete_category($category_ID);
-        }
-        // doesn't matter what page we're coming from... we're going to the same place after delete.
-        $query_args = [
-            'action' => 'category_list',
-        ];
-        $this->_redirect_after_action(0, '', '', $query_args);
-    }
-
-
-    /**
-     * Handles deleting specific category.
-     *
-     * @param int $cat_id
-     */
-    protected function _delete_category($cat_id)
-    {
-        $cat_id = absint($cat_id);
-        wp_delete_term($cat_id, EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY);
-    }
-
-
-    /**
-     * Handles triggering the update or insertion of a new category.
-     *
-     * @param bool $new_category true means we're triggering the insert of a new category.
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    protected function _insert_or_update_category($new_category)
-    {
-        $cat_id  = $new_category ? $this->_insert_category() : $this->_insert_category(true);
-        $success = 0; // we already have a success message so lets not send another.
-        if ($cat_id) {
-            $query_args = [
-                'action'     => 'edit_category',
-                'EVT_CAT_ID' => $cat_id,
-            ];
-        } else {
-            $query_args = ['action' => 'add_category'];
-        }
-        $this->_redirect_after_action($success, '', '', $query_args, true);
-    }
-
-
-    /**
-     * Inserts or updates category
-     *
-     * @param bool $update (true indicates we're updating a category).
-     * @return bool|mixed|string
-     */
-    private function _insert_category($update = false)
-    {
-        $category_ID         = $update ? $this->request->getRequestParam('EVT_CAT_ID', 0, 'int') : 0;
-        $category_name       = $this->request->getRequestParam('category_name', '');
-        $category_desc       = $this->request->getRequestParam('category_desc', '');
-        $category_parent     = $this->request->getRequestParam('category_parent', 0, 'int');
-        $category_identifier = $this->request->getRequestParam('category_identifier', '');
-
-        if (empty($category_name)) {
-            $msg = esc_html__('You must add a name for the category.', 'event_espresso');
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        $term_args = [
-            'name'        => $category_name,
-            'description' => $category_desc,
-            'parent'      => $category_parent,
-        ];
-        // was the category_identifier input disabled?
-        if ($category_identifier) {
-            $term_args['slug'] = $category_identifier;
-        }
-        $insert_ids = $update
-            ? wp_update_term($category_ID, EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY, $term_args)
-            : wp_insert_term($category_name, EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY, $term_args);
-        if (! is_array($insert_ids)) {
-            $msg = esc_html__(
-                'An error occurred and the category has not been saved to the database.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-        } else {
-            $category_ID = $insert_ids['term_id'];
-            $msg         = sprintf(
-                esc_html__('The category %s was successfully saved', 'event_espresso'),
-                $category_name
-            );
-            EE_Error::add_success($msg);
-        }
-        return $category_ID;
-    }
-
-
-    /**
-     * Gets categories or count of categories matching the arguments in the request.
-     *
-     * @param int  $per_page
-     * @param int  $current_page
-     * @param bool $count
-     * @return EE_Term_Taxonomy[]|int
-     * @throws EE_Error
-     */
-    public function get_categories($per_page = 10, $current_page = 1, $count = false)
-    {
-        // testing term stuff
-        $orderby     = $this->request->getRequestParam('orderby', 'Term.term_id');
-        $order       = $this->request->getRequestParam('order', 'DESC');
-        $limit       = ($current_page - 1) * $per_page;
-        $where       = ['taxonomy' => EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY];
-        $search_term = $this->request->getRequestParam('s');
-        if ($search_term) {
-            $search_term = '%' . $search_term . '%';
-            $where['OR'] = [
-                'Term.name'   => ['LIKE', $search_term],
-                'description' => ['LIKE', $search_term],
-            ];
-        }
-        $query_params = [
-            $where,
-            'order_by'   => [$orderby => $order],
-            'limit'      => $limit . ',' . $per_page,
-            'force_join' => ['Term'],
-        ];
-        return $count
-            ? EEM_Term_Taxonomy::instance()->count($query_params, 'term_id')
-            : EEM_Term_Taxonomy::instance()->get_all($query_params);
-    }
-
-    /* end category stuff */
-
-
-    /**************/
-
-
-    /**
-     * Callback for the `ee_save_timezone_setting` ajax action.
-     *
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function saveTimezoneString()
-    {
-        $timezone_string = $this->request->getRequestParam('timezone_selected');
-        if (empty($timezone_string) || ! EEH_DTT_Helper::validate_timezone($timezone_string, false)) {
-            EE_Error::add_error(
-                esc_html__('An invalid timezone string submitted.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $this->_template_args['error'] = true;
-            $this->_return_json();
-        }
-
-        update_option('timezone_string', $timezone_string);
-        EE_Error::add_success(
-            esc_html__('Your timezone string was updated.', 'event_espresso')
-        );
-        $this->_template_args['success'] = true;
-        $this->_return_json(true, ['action' => 'create_new']);
-    }
-
-
-    /**
      * @throws EE_Error
-     * @deprecated 4.10.25.p
      */
-    public function save_timezonestring_setting()
-    {
-        $this->saveTimezoneString();
-    }
+	protected function _template_settings()
+	{
+		$this->_admin_page_title              = esc_html__('Template Settings (Preview)', 'event_espresso');
+		$this->_template_args['preview_img']  = '<img src="'
+												. EVENTS_ASSETS_URL
+												. '/images/'
+												. 'caffeinated_template_features.jpg" alt="'
+												. esc_attr__('Template Settings Preview screenshot', 'event_espresso')
+												. '" />';
+		$this->_template_args['preview_text'] = '<strong>'
+												. esc_html__(
+													'Template Settings is a feature that is only available in the premium version of Event Espresso 4 which is available with a support license purchase on EventEspresso.com. Template Settings allow you to configure some of the appearance options for both the Event List and Event Details pages.',
+													'event_espresso'
+												) . '</strong>';
+		$this->display_admin_caf_preview_page('template_settings_tab');
+	}
+
+
+	/** Event Category Stuff **/
+	/**
+	 * set the _category property with the category object for the loaded page.
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _set_category_object()
+	{
+		if (isset($this->_category->id) && ! empty($this->_category->id)) {
+			return;
+		} //already have the category object so get out.
+		// set default category object
+		$this->_set_empty_category_object();
+		// only set if we've got an id
+		$category_ID = $this->request->getRequestParam('EVT_CAT_ID', 0, 'int');
+		if (! $category_ID) {
+			return;
+		}
+		$term = get_term($category_ID, EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY);
+		if (! empty($term)) {
+			$this->_category->category_name       = $term->name;
+			$this->_category->category_identifier = $term->slug;
+			$this->_category->category_desc       = $term->description;
+			$this->_category->id                  = $term->term_id;
+			$this->_category->parent              = $term->parent;
+		}
+	}
+
+
+	/**
+	 * Clears out category properties.
+	 */
+	private function _set_empty_category_object()
+	{
+		$this->_category                = new stdClass();
+		$this->_category->category_name = $this->_category->category_identifier = $this->_category->category_desc = '';
+		$this->_category->id            = $this->_category->parent = 0;
+	}
+
+
+	/**
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _category_list_table()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$this->_search_btn_label = esc_html__('Categories', 'event_espresso');
+		$this->_admin_page_title .= ' ';
+		$this->_admin_page_title .= $this->get_action_link_or_button(
+			'add_category',
+			'add_category',
+			[],
+			'add-new-h2'
+		);
+		$this->display_admin_list_table_page_with_sidebar();
+	}
+
+
+	/**
+	 * Output category details view.
+	 *
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	protected function _category_details($view)
+	{
+		// load formatter helper
+		// load field generator helper
+		$route = $view === 'edit' ? 'update_category' : 'insert_category';
+		$this->_set_add_edit_form_tags($route);
+		$this->_set_category_object();
+		$id            = ! empty($this->_category->id) ? $this->_category->id : '';
+		$delete_action = 'delete_category';
+		// custom redirect
+		$redirect = EE_Admin_Page::add_query_args_and_nonce(
+			['action' => 'category_list'],
+			$this->_admin_base_url
+		);
+		$this->_set_publish_post_box_vars('EVT_CAT_ID', $id, $delete_action, $redirect);
+		// take care of contents
+		$this->_template_args['admin_page_content'] = $this->_category_details_content();
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * Output category details content.
+	 *
+	 * @throws DomainException
+	 */
+	protected function _category_details_content()
+	{
+		$editor_args['category_desc'] = [
+			'type'          => 'wp_editor',
+			'value'         => EEH_Formatter::admin_format_content($this->_category->category_desc),
+			'class'         => 'my_editor_custom',
+			'wpeditor_args' => ['media_buttons' => false],
+		];
+		$_wp_editor                   = $this->_generate_admin_form_fields($editor_args, 'array');
+		$all_terms                    = get_terms(
+			[EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY],
+			['hide_empty' => 0, 'exclude' => [$this->_category->id]]
+		);
+		// setup category select for term parents.
+		$category_select_values[] = [
+			'text' => esc_html__('No Parent', 'event_espresso'),
+			'id'   => 0,
+		];
+		foreach ($all_terms as $term) {
+			$category_select_values[] = [
+				'text' => $term->name,
+				'id'   => $term->term_id,
+			];
+		}
+		$category_select = EEH_Form_Fields::select_input(
+			'category_parent',
+			$category_select_values,
+			$this->_category->parent
+		);
+		$template_args   = [
+			'category'                 => $this->_category,
+			'category_select'          => $category_select,
+			'unique_id_info_help_link' => $this->_get_help_tab_link('unique_id_info'),
+			'category_desc_editor'     => $_wp_editor['category_desc']['field'],
+			'disable'                  => '',
+			'disabled_message'         => false,
+		];
+		$template        = EVENTS_TEMPLATE_PATH . 'event_category_details.template.php';
+		return EEH_Template::display_template($template, $template_args, true);
+	}
+
+
+	/**
+	 * Handles deleting categories.
+	 *
+	 * @throws EE_Error
+	 */
+	protected function _delete_categories()
+	{
+		$category_IDs = $this->request->getRequestParam('EVT_CAT_ID', 0, 'int', true);
+		foreach ($category_IDs as $category_ID) {
+			$this->_delete_category($category_ID);
+		}
+		// doesn't matter what page we're coming from... we're going to the same place after delete.
+		$query_args = [
+			'action' => 'category_list',
+		];
+		$this->_redirect_after_action(0, '', '', $query_args);
+	}
+
+
+	/**
+	 * Handles deleting specific category.
+	 *
+	 * @param int $cat_id
+	 */
+	protected function _delete_category($cat_id)
+	{
+		$cat_id = absint($cat_id);
+		wp_delete_term($cat_id, EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY);
+	}
+
+
+	/**
+	 * Handles triggering the update or insertion of a new category.
+	 *
+	 * @param bool $new_category true means we're triggering the insert of a new category.
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	protected function _insert_or_update_category($new_category)
+	{
+		$cat_id  = $new_category ? $this->_insert_category() : $this->_insert_category(true);
+		$success = 0; // we already have a success message so lets not send another.
+		if ($cat_id) {
+			$query_args = [
+				'action'     => 'edit_category',
+				'EVT_CAT_ID' => $cat_id,
+			];
+		} else {
+			$query_args = ['action' => 'add_category'];
+		}
+		$this->_redirect_after_action($success, '', '', $query_args, true);
+	}
+
+
+	/**
+	 * Inserts or updates category
+	 *
+	 * @param bool $update (true indicates we're updating a category).
+	 * @return bool|mixed|string
+	 */
+	private function _insert_category($update = false)
+	{
+		$category_ID         = $update ? $this->request->getRequestParam('EVT_CAT_ID', 0, 'int') : 0;
+		$category_name       = $this->request->getRequestParam('category_name', '');
+		$category_desc       = $this->request->getRequestParam('category_desc', '');
+		$category_parent     = $this->request->getRequestParam('category_parent', 0, 'int');
+		$category_identifier = $this->request->getRequestParam('category_identifier', '');
+
+		if (empty($category_name)) {
+			$msg = esc_html__('You must add a name for the category.', 'event_espresso');
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		$term_args = [
+			'name'        => $category_name,
+			'description' => $category_desc,
+			'parent'      => $category_parent,
+		];
+		// was the category_identifier input disabled?
+		if ($category_identifier) {
+			$term_args['slug'] = $category_identifier;
+		}
+		$insert_ids = $update
+			? wp_update_term($category_ID, EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY, $term_args)
+			: wp_insert_term($category_name, EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY, $term_args);
+		if (! is_array($insert_ids)) {
+			$msg = esc_html__(
+				'An error occurred and the category has not been saved to the database.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+		} else {
+			$category_ID = $insert_ids['term_id'];
+			$msg         = sprintf(
+				esc_html__('The category %s was successfully saved', 'event_espresso'),
+				$category_name
+			);
+			EE_Error::add_success($msg);
+		}
+		return $category_ID;
+	}
+
+
+	/**
+	 * Gets categories or count of categories matching the arguments in the request.
+	 *
+	 * @param int  $per_page
+	 * @param int  $current_page
+	 * @param bool $count
+	 * @return EE_Term_Taxonomy[]|int
+	 * @throws EE_Error
+	 */
+	public function get_categories($per_page = 10, $current_page = 1, $count = false)
+	{
+		// testing term stuff
+		$orderby     = $this->request->getRequestParam('orderby', 'Term.term_id');
+		$order       = $this->request->getRequestParam('order', 'DESC');
+		$limit       = ($current_page - 1) * $per_page;
+		$where       = ['taxonomy' => EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY];
+		$search_term = $this->request->getRequestParam('s');
+		if ($search_term) {
+			$search_term = '%' . $search_term . '%';
+			$where['OR'] = [
+				'Term.name'   => ['LIKE', $search_term],
+				'description' => ['LIKE', $search_term],
+			];
+		}
+		$query_params = [
+			$where,
+			'order_by'   => [$orderby => $order],
+			'limit'      => $limit . ',' . $per_page,
+			'force_join' => ['Term'],
+		];
+		return $count
+			? EEM_Term_Taxonomy::instance()->count($query_params, 'term_id')
+			: EEM_Term_Taxonomy::instance()->get_all($query_params);
+	}
+
+	/* end category stuff */
+
+
+	/**************/
+
+
+	/**
+	 * Callback for the `ee_save_timezone_setting` ajax action.
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function saveTimezoneString()
+	{
+		$timezone_string = $this->request->getRequestParam('timezone_selected');
+		if (empty($timezone_string) || ! EEH_DTT_Helper::validate_timezone($timezone_string, false)) {
+			EE_Error::add_error(
+				esc_html__('An invalid timezone string submitted.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$this->_template_args['error'] = true;
+			$this->_return_json();
+		}
+
+		update_option('timezone_string', $timezone_string);
+		EE_Error::add_success(
+			esc_html__('Your timezone string was updated.', 'event_espresso')
+		);
+		$this->_template_args['success'] = true;
+		$this->_return_json(true, ['action' => 'create_new']);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @deprecated 4.10.25.p
+	 */
+	public function save_timezonestring_setting()
+	{
+		$this->saveTimezoneString();
+	}
 }

Spacing +90 added lines, -90 removed lines

@@ -434,7 +434,7 @@ 
             // template settings
             'template_settings'      => [
                 'nav'           => [
-                    'label' => esc_html__( 'Templates', 'event_espresso'),
+                    'label' => esc_html__('Templates', 'event_espresso'),
                     'icon' => 'dashicons-layout',
                     'order' => 30,
                 ],
@@ -580,13 +580,13 @@ 
     {
         wp_register_style(
             'events-admin-css',
-            EVENTS_ASSETS_URL . 'events-admin-page.css',
+            EVENTS_ASSETS_URL.'events-admin-page.css',
             [],
             EVENT_ESPRESSO_VERSION
         );
         wp_register_style(
             'ee-cat-admin',
-            EVENTS_ASSETS_URL . 'ee-cat-admin.css',
+            EVENTS_ASSETS_URL.'ee-cat-admin.css',
             [],
             EVENT_ESPRESSO_VERSION
         );
@@ -595,7 +595,7 @@ 
         // scripts
         wp_register_script(
             'event_editor_js',
-            EVENTS_ASSETS_URL . 'event_editor.js',
+            EVENTS_ASSETS_URL.'event_editor.js',
             ['ee_admin_js', 'jquery-ui-slider', 'jquery-ui-timepicker-addon'],
             EVENT_ESPRESSO_VERSION,
             true
@@ -621,16 +621,16 @@ 
         wp_enqueue_style('espresso-ui-theme');
         wp_register_style(
             'event-editor-css',
-            EVENTS_ASSETS_URL . 'event-editor.css',
+            EVENTS_ASSETS_URL.'event-editor.css',
             ['ee-admin-css'],
             EVENT_ESPRESSO_VERSION
         );
         wp_enqueue_style('event-editor-css');
         // scripts
-        if (! $this->admin_config->useAdvancedEditor()) {
+        if ( ! $this->admin_config->useAdvancedEditor()) {
             wp_register_script(
                 'event-datetime-metabox',
-                EVENTS_ASSETS_URL . 'event-datetime-metabox.js',
+                EVENTS_ASSETS_URL.'event-datetime-metabox.js',
                 ['event_editor_js', 'ee-datepicker'],
                 EVENT_ESPRESSO_VERSION
             );
@@ -700,15 +700,15 @@ 
     public function verify_event_edit($event = null, $req_type = '')
     {
         // don't need to do this when processing
-        if (! empty($req_type)) {
+        if ( ! empty($req_type)) {
             return;
         }
         // no event?
-        if (! $event instanceof EE_Event) {
+        if ( ! $event instanceof EE_Event) {
             $event = $this->_cpt_model_obj;
         }
         // STILL no event?
-        if (! $event instanceof EE_Event) {
+        if ( ! $event instanceof EE_Event) {
             return;
         }
         $orig_status = $event->status();
@@ -748,7 +748,7 @@ 
             );
         }
         // now we need to determine if the event has any tickets on sale.  If not then we dont' show the error
-        if (! $event->tickets_on_sale()) {
+        if ( ! $event->tickets_on_sale()) {
             return;
         }
         // made it here so show warning
@@ -796,7 +796,7 @@ 
     {
         $has_timezone_string = get_option('timezone_string');
         // only nag them about setting their timezone if it's their first event, and they haven't already done it
-        if (! $has_timezone_string && ! EEM_Event::instance()->exists([])) {
+        if ( ! $has_timezone_string && ! EEM_Event::instance()->exists([])) {
             EE_Error::add_attention(
                 sprintf(
                     esc_html__(
@@ -865,7 +865,7 @@ 
      */
     protected function _event_legend_items()
     {
-        $items    = [
+        $items = [
             'view_details'   => [
                 'class' => 'dashicons dashicons-visibility',
                 'desc'  => esc_html__('View Event', 'event_espresso'),
@@ -882,31 +882,31 @@ 
         $items    = apply_filters('FHEE__Events_Admin_Page___event_legend_items__items', $items);
         $statuses = [
             'sold_out_status'  => [
-                'class' => 'ee-status-legend ee-status-bg--' . EE_Datetime::sold_out,
+                'class' => 'ee-status-legend ee-status-bg--'.EE_Datetime::sold_out,
                 'desc'  => EEH_Template::pretty_status(EE_Datetime::sold_out, false, 'sentence'),
             ],
             'active_status'    => [
-                'class' => 'ee-status-legend ee-status-bg--' . EE_Datetime::active,
+                'class' => 'ee-status-legend ee-status-bg--'.EE_Datetime::active,
                 'desc'  => EEH_Template::pretty_status(EE_Datetime::active, false, 'sentence'),
             ],
             'upcoming_status'  => [
-                'class' => 'ee-status-legend ee-status-bg--' . EE_Datetime::upcoming,
+                'class' => 'ee-status-legend ee-status-bg--'.EE_Datetime::upcoming,
                 'desc'  => EEH_Template::pretty_status(EE_Datetime::upcoming, false, 'sentence'),
             ],
             'postponed_status' => [
-                'class' => 'ee-status-legend ee-status-bg--' . EE_Datetime::postponed,
+                'class' => 'ee-status-legend ee-status-bg--'.EE_Datetime::postponed,
                 'desc'  => EEH_Template::pretty_status(EE_Datetime::postponed, false, 'sentence'),
             ],
             'cancelled_status' => [
-                'class' => 'ee-status-legend ee-status-bg--' . EE_Datetime::cancelled,
+                'class' => 'ee-status-legend ee-status-bg--'.EE_Datetime::cancelled,
                 'desc'  => EEH_Template::pretty_status(EE_Datetime::cancelled, false, 'sentence'),
             ],
             'expired_status'   => [
-                'class' => 'ee-status-legend ee-status-bg--' . EE_Datetime::expired,
+                'class' => 'ee-status-legend ee-status-bg--'.EE_Datetime::expired,
                 'desc'  => EEH_Template::pretty_status(EE_Datetime::expired, false, 'sentence'),
             ],
             'inactive_status'  => [
-                'class' => 'ee-status-legend ee-status-bg--' . EE_Datetime::inactive,
+                'class' => 'ee-status-legend ee-status-bg--'.EE_Datetime::inactive,
                 'desc'  => EEH_Template::pretty_status(EE_Datetime::inactive, false, 'sentence'),
             ],
         ];
@@ -925,7 +925,7 @@ 
      */
     private function _event_model()
     {
-        if (! $this->_event_model instanceof EEM_Event) {
+        if ( ! $this->_event_model instanceof EEM_Event) {
             $this->_event_model = EE_Registry::instance()->load_model('Event');
         }
         return $this->_event_model;
@@ -945,7 +945,7 @@ 
     public function extra_permalink_field_buttons($return, $id, $new_title, $new_slug)
     {
         // make sure this is only when editing
-        if (! empty($id)) {
+        if ( ! empty($id)) {
             $post = get_post($id);
             $return .= '<a class="button button--small button--secondary" onclick="prompt(\'Shortcode:\', jQuery(\'#shortcode\').val()); return false;" href="#"  tabindex="-1">'
                        . esc_html__('Shortcode', 'event_espresso')
@@ -972,7 +972,7 @@ 
      */
     protected function _events_overview_list_table()
     {
-        $after_list_table                           = [];
+        $after_list_table = [];
         $links_html = EEH_HTML::div('', '', 'ee-admin-section ee-layout-stack');
         $links_html .= EEH_HTML::h3(esc_html__('Links', 'event_espresso'));
         $links_html .= EEH_HTML::div(
@@ -989,14 +989,14 @@ 
         $after_list_table['view_event_list_button'] = $links_html;
 
         $after_list_table['legend'] = $this->_display_legend($this->_event_legend_items());
-        $this->_admin_page_title                    .= ' ' . $this->get_action_link_or_button(
+        $this->_admin_page_title .= ' '.$this->get_action_link_or_button(
             'create_new',
             'add',
             [],
             'add-new-h2'
         );
 
-        $this->_template_args['after_list_table']   = array_merge(
+        $this->_template_args['after_list_table'] = array_merge(
             (array) $this->_template_args['after_list_table'],
             $after_list_table
         );
@@ -1053,13 +1053,13 @@ 
             'EVT_timezone_string' => $this->request->getRequestParam('timezone_string'),
         ];
         // check if the new EDTR reg options meta box is being used, and if so, don't run updates for legacy version
-        if (! $this->admin_config->useAdvancedEditor() || ! $this->feature->allowed('use_reg_options_meta_box')) {
-            $event_values['EVT_display_ticket_selector']     = $this->request->getRequestParam(
+        if ( ! $this->admin_config->useAdvancedEditor() || ! $this->feature->allowed('use_reg_options_meta_box')) {
+            $event_values['EVT_display_ticket_selector'] = $this->request->getRequestParam(
                 'display_ticket_selector',
                 false,
                 'bool'
             );
-            $event_values['EVT_additional_limit']            = min(
+            $event_values['EVT_additional_limit'] = min(
                 apply_filters('FHEE__EE_Events_Admin__insert_update_cpt_item__EVT_additional_limit_max', 255),
                 $this->request->getRequestParam('additional_limit', null, 'int')
             );
@@ -1095,7 +1095,7 @@ 
         // the following are default callbacks for event attachment updates
         // that can be overridden by caffeinated functionality and/or addons.
         $event_update_callbacks = [];
-        if (! $this->admin_config->useAdvancedEditor()) {
+        if ( ! $this->admin_config->useAdvancedEditor()) {
             $event_update_callbacks['_default_venue_update']   = [$this, '_default_venue_update'];
             $event_update_callbacks['_default_tickets_update'] = [$this, '_default_tickets_update'];
         }
@@ -1166,7 +1166,7 @@ 
      */
     protected function _default_venue_update(EE_Event $event, $data)
     {
-        require_once(EE_MODELS . 'EEM_Venue.model.php');
+        require_once(EE_MODELS.'EEM_Venue.model.php');
         $venue_model = EE_Registry::instance()->load_model('Venue');
         $venue_id    = ! empty($data['venue_id']) ? $data['venue_id'] : null;
         // very important.  If we don't have a venue name...
@@ -1197,7 +1197,7 @@ 
             'status'              => 'publish',
         ];
         // if we've got the venue_id then we're just updating the existing venue so let's do that and then get out.
-        if (! empty($venue_id)) {
+        if ( ! empty($venue_id)) {
             $update_where  = [$venue_model->primary_key_name() => $venue_id];
             $rows_affected = $venue_model->update($venue_array, [$update_where]);
             // we've gotta make sure that the venue is always attached to a revision..
@@ -1239,7 +1239,7 @@ 
                 isset($datetime_data['DTT_EVT_end']) && ! empty($datetime_data['DTT_EVT_end'])
                     ? $datetime_data['DTT_EVT_end']
                     : $datetime_data['DTT_EVT_start'];
-            $datetime_values              = [
+            $datetime_values = [
                 'DTT_ID'        => ! empty($datetime_data['DTT_ID']) ? $datetime_data['DTT_ID'] : null,
                 'DTT_EVT_start' => $datetime_data['DTT_EVT_start'],
                 'DTT_EVT_end'   => $datetime_data['DTT_EVT_end'],
@@ -1248,9 +1248,9 @@ 
             ];
             // if we have an id then let's get existing object first and then set the new values.
             //  Otherwise we instantiate a new object for save.
-            if (! empty($datetime_data['DTT_ID'])) {
+            if ( ! empty($datetime_data['DTT_ID'])) {
                 $datetime = EEM_Datetime::instance($event_timezone)->get_one_by_ID($datetime_data['DTT_ID']);
-                if (! $datetime instanceof EE_Datetime) {
+                if ( ! $datetime instanceof EE_Datetime) {
                     throw new RuntimeException(
                         sprintf(
                             esc_html__(
@@ -1269,7 +1269,7 @@ 
             } else {
                 $datetime = EE_Datetime::new_instance($datetime_values, $event_timezone, $date_formats);
             }
-            if (! $datetime instanceof EE_Datetime) {
+            if ( ! $datetime instanceof EE_Datetime) {
                 throw new RuntimeException(
                     sprintf(
                         esc_html__(
@@ -1295,7 +1295,7 @@ 
 
         // set up some default start and end dates in case those are not present in the incoming data
         $default_start_date = new DateTime('now', new DateTimeZone($event->get_timezone()));
-        $default_start_date = $default_start_date->format($date_formats[0] . ' ' . $date_formats[1]);
+        $default_start_date = $default_start_date->format($date_formats[0].' '.$date_formats[1]);
         // use the start date of the first datetime for the end date
         $first_datetime   = $event->first_datetime();
         $default_end_date = $first_datetime->start_date_and_time($date_formats[0], $date_formats[1]);
@@ -1303,8 +1303,8 @@ 
         // now process the incoming data
         foreach ($data['edit_tickets'] as $row => $ticket_data) {
             $update_prices = false;
-            $ticket_price  = isset($data['edit_prices'][ $row ][1]['PRC_amount'])
-                ? $data['edit_prices'][ $row ][1]['PRC_amount']
+            $ticket_price  = isset($data['edit_prices'][$row][1]['PRC_amount'])
+                ? $data['edit_prices'][$row][1]['PRC_amount']
                 : 0;
             // trim inputs to ensure any excess whitespace is removed.
             $ticket_data   = array_map('trim', $ticket_data);
@@ -1345,9 +1345,9 @@ 
             // ticket didn't get removed or added to any datetime in the session but DID have it's items modified.
             // keep in mind that if the ticket has been sold (and we have changed pricing information),
             // then we won't be updating the tkt but instead a new tkt will be created and the old one archived.
-            if (! empty($ticket_data['TKT_ID'])) {
+            if ( ! empty($ticket_data['TKT_ID'])) {
                 $existing_ticket = EEM_Ticket::instance($event_timezone)->get_one_by_ID($ticket_data['TKT_ID']);
-                if (! $existing_ticket instanceof EE_Ticket) {
+                if ( ! $existing_ticket instanceof EE_Ticket) {
                     throw new RuntimeException(
                         sprintf(
                             esc_html__(
@@ -1396,7 +1396,7 @@ 
                     $existing_ticket->save();
                     // make sure this ticket is still recorded in our $saved_tickets
                     // so we don't run it through the regular trash routine.
-                    $saved_tickets[ $existing_ticket->ID() ] = $existing_ticket;
+                    $saved_tickets[$existing_ticket->ID()] = $existing_ticket;
                     // create new ticket that's a copy of the existing except,
                     // (a new id of course and not archived) AND has the new TKT_price associated with it.
                     $new_ticket = clone $existing_ticket;
@@ -1413,7 +1413,7 @@ 
                 $ticket                     = EE_Ticket::new_instance($ticket_values, $event_timezone, $date_formats);
                 $update_prices              = true;
             }
-            if (! $ticket instanceof EE_Ticket) {
+            if ( ! $ticket instanceof EE_Ticket) {
                 throw new RuntimeException(
                     sprintf(
                         esc_html__(
@@ -1437,10 +1437,10 @@ 
             }
             // initially let's add the ticket to the datetime
             $datetime->_add_relation_to($ticket, 'Ticket');
-            $saved_tickets[ $ticket->ID() ] = $ticket;
+            $saved_tickets[$ticket->ID()] = $ticket;
             // add prices to ticket
-            $prices_data = isset($data['edit_prices'][ $row ]) && is_array($data['edit_prices'][ $row ])
-                ? $data['edit_prices'][ $row ]
+            $prices_data = isset($data['edit_prices'][$row]) && is_array($data['edit_prices'][$row])
+                ? $data['edit_prices'][$row]
                 : [];
             $this->_add_prices_to_ticket($prices_data, $ticket, $update_prices);
         }
@@ -1454,7 +1454,7 @@ 
             $id = absint($id);
             // get the ticket for this id
             $ticket_to_remove = EEM_Ticket::instance()->get_one_by_ID($id);
-            if (! $ticket_to_remove instanceof EE_Ticket) {
+            if ( ! $ticket_to_remove instanceof EE_Ticket) {
                 continue;
             }
             // need to get all the related datetimes on this ticket and remove from every single one of them
@@ -1511,7 +1511,7 @@ 
                     $price->set($field, $new_price);
                 }
             }
-            if (! $price instanceof EE_Price) {
+            if ( ! $price instanceof EE_Price) {
                 throw new RuntimeException(
                     sprintf(
                         esc_html__(
@@ -1553,13 +1553,13 @@ 
     {
         // load formatter helper
         // args for getting related registrations
-        $approved_query_args        = [
+        $approved_query_args = [
             [
                 'REG_deleted' => 0,
                 'STS_ID'      => EEM_Registration::status_id_approved,
             ],
         ];
-        $not_approved_query_args    = [
+        $not_approved_query_args = [
             [
                 'REG_deleted' => 0,
                 'STS_ID'      => EEM_Registration::status_id_not_approved,
@@ -1622,7 +1622,7 @@ 
         $publish_box_extra_args['event_editor_overview_add'] = ob_get_clean();
         // load template
         EEH_Template::display_template(
-            EVENTS_TEMPLATE_PATH . 'event_publish_box_extras.template.php',
+            EVENTS_TEMPLATE_PATH.'event_publish_box_extras.template.php',
             $publish_box_extra_args
         );
     }
@@ -1653,7 +1653,7 @@ 
         $this->verify_cpt_object();
         $use_advanced_editor = $this->admin_config->useAdvancedEditor();
         // check if the new EDTR reg options meta box is being used, and if so, don't load the legacy version
-        if (! $use_advanced_editor || ! $this->feature->allowed('use_reg_options_meta_box')) {
+        if ( ! $use_advanced_editor || ! $this->feature->allowed('use_reg_options_meta_box')) {
             $this->addMetaBox(
                 'espresso_event_editor_event_options',
                 esc_html__('Event Registration Options', 'event_espresso'),
@@ -1662,7 +1662,7 @@ 
                 'side'
             );
         }
-        if (! $use_advanced_editor) {
+        if ( ! $use_advanced_editor) {
             $this->addMetaBox(
                 'espresso_event_editor_tickets',
                 esc_html__('Event Datetime & Ticket', 'event_espresso'),
@@ -1674,7 +1674,7 @@ 
         } elseif ($this->feature->allowed('use_reg_options_meta_box')) {
             add_action(
                 'add_meta_boxes_espresso_events',
-                function () {
+                function() {
                     global $current_screen;
                     remove_meta_box('authordiv', $current_screen, 'normal');
                 },
@@ -1709,7 +1709,7 @@ 
             'trash_icon'               => 'dashicons dashicons-lock',
             'disabled'                 => '',
         ];
-        $event_id      = is_object($this->_cpt_model_obj) ? $this->_cpt_model_obj->ID() : null;
+        $event_id = is_object($this->_cpt_model_obj) ? $this->_cpt_model_obj->ID() : null;
         /**
          * 1. Start with retrieving Datetimes
          * 2. Fore each datetime get related tickets
@@ -1735,24 +1735,24 @@ 
                     'default_where_conditions' => 'none',
                 ]
             );
-            if (! empty($related_tickets)) {
+            if ( ! empty($related_tickets)) {
                 $template_args['total_ticket_rows'] = count($related_tickets);
                 $row                                = 0;
                 foreach ($related_tickets as $ticket) {
-                    $existing_ticket_ids[]        = $ticket->get('TKT_ID');
+                    $existing_ticket_ids[] = $ticket->get('TKT_ID');
                     $template_args['ticket_rows'] .= $this->_get_ticket_row($ticket, false, $row);
                     $row++;
                 }
             } else {
                 $template_args['total_ticket_rows'] = 1;
                 /** @type EE_Ticket $ticket */
-                $ticket                       = $ticket_model->create_default_object();
+                $ticket = $ticket_model->create_default_object();
                 $template_args['ticket_rows'] .= $this->_get_ticket_row($ticket);
             }
         } else {
             $template_args['time'] = $times[0];
             /** @type EE_Ticket[] $tickets */
-            $tickets                      = $ticket_model->get_all_default_tickets();
+            $tickets = $ticket_model->get_all_default_tickets();
             $template_args['ticket_rows'] .= $this->_get_ticket_row($tickets[1]);
             // NOTE: we're just sending the first default row
             // (decaf can't manage default tickets so this should be sufficient);
@@ -1767,9 +1767,9 @@ 
             $ticket_model->create_default_object(),
             true
         );
-        $template                                  = apply_filters(
+        $template = apply_filters(
             'FHEE__Events_Admin_Page__ticket_metabox__template',
-            EVENTS_TEMPLATE_PATH . 'event_tickets_metabox_main.template.php'
+            EVENTS_TEMPLATE_PATH.'event_tickets_metabox_main.template.php'
         );
         EEH_Template::display_template($template, $template_args);
     }
@@ -1789,7 +1789,7 @@ 
     private function _get_ticket_row($ticket, $skeleton = false, $row = 0)
     {
         $template_args = [
-            'tkt_status_class'    => ' tkt-status-' . $ticket->ticket_status(),
+            'tkt_status_class'    => ' tkt-status-'.$ticket->ticket_status(),
             'tkt_archive_class'   => $ticket->ticket_status() === EE_Ticket::archived && ! $skeleton ? ' tkt-archived'
                 : '',
             'ticketrow'           => $skeleton ? 'TICKETNUM' : $row,
@@ -1801,10 +1801,10 @@ 
             'TKT_qty'             => $ticket->get_pretty('TKT_qty', 'input'),
             'edit_ticketrow_name' => $skeleton ? 'TICKETNAMEATTR' : 'edit_tickets',
             'TKT_sold'            => $skeleton ? 0 : $ticket->get('TKT_sold'),
-            'trash_icon'          => ($skeleton || (! empty($ticket) && ! $ticket->get('TKT_deleted')))
-                                     && (! empty($ticket) && $ticket->get('TKT_sold') === 0)
+            'trash_icon'          => ($skeleton || ( ! empty($ticket) && ! $ticket->get('TKT_deleted')))
+                                     && ( ! empty($ticket) && $ticket->get('TKT_sold') === 0)
                 ? 'trash-icon dashicons dashicons-post-trash clickable' : 'dashicons dashicons-lock',
-            'disabled'            => $skeleton || (! empty($ticket) && ! $ticket->get('TKT_deleted')) ? ''
+            'disabled'            => $skeleton || ( ! empty($ticket) && ! $ticket->get('TKT_deleted')) ? ''
                 : ' disabled=disabled',
         ];
         $price         = $ticket->ID() !== 0
@@ -1828,7 +1828,7 @@ 
         }
         if (empty($template_args['TKT_end_date'])) {
             // get the earliest datetime (if present);
-            $earliest_datetime             = $this->_cpt_model_obj->ID() > 0
+            $earliest_datetime = $this->_cpt_model_obj->ID() > 0
                 ? $this->_cpt_model_obj->get_first_related(
                     'Datetime',
                     ['order_by' => ['DTT_EVT_start' => 'ASC']]
@@ -1841,7 +1841,7 @@ 
         $template_args = array_merge($template_args, $price_args);
         $template      = apply_filters(
             'FHEE__Events_Admin_Page__get_ticket_row__template',
-            EVENTS_TEMPLATE_PATH . 'event_tickets_metabox_ticket_row.template.php',
+            EVENTS_TEMPLATE_PATH.'event_tickets_metabox_ticket_row.template.php',
             $ticket
         );
         return EEH_Template::display_template($template, $template_args, true);
@@ -1854,7 +1854,7 @@ 
      */
     public function registration_options_meta_box()
     {
-        $yes_no_values             = [
+        $yes_no_values = [
             ['id' => true, 'text' => esc_html__('Yes', 'event_espresso')],
             ['id' => false, 'text' => esc_html__('No', 'event_espresso')],
         ];
@@ -1876,12 +1876,12 @@ 
             $default_reg_status_values,
             $this->_cpt_model_obj->default_registration_status()
         );
-        $template_args['display_description']             = EEH_Form_Fields::select_input(
+        $template_args['display_description'] = EEH_Form_Fields::select_input(
             'display_desc',
             $yes_no_values,
             $this->_cpt_model_obj->display_description()
         );
-        $template_args['display_ticket_selector']         = EEH_Form_Fields::select_input(
+        $template_args['display_ticket_selector'] = EEH_Form_Fields::select_input(
             'display_ticket_selector',
             $yes_no_values,
             $this->_cpt_model_obj->display_ticket_selector(),
@@ -1897,7 +1897,7 @@ 
             $default_reg_status_values
         );
         EEH_Template::display_template(
-            EVENTS_TEMPLATE_PATH . 'event_registration_options.template.php',
+            EVENTS_TEMPLATE_PATH.'event_registration_options.template.php',
             $template_args
         );
     }
@@ -1920,7 +1920,7 @@ 
     {
         $EEM_Event   = $this->_event_model();
         $offset      = ($current_page - 1) * $per_page;
-        $limit       = $count ? null : $offset . ',' . $per_page;
+        $limit       = $count ? null : $offset.','.$per_page;
         $orderby     = $this->request->getRequestParam('orderby', 'EVT_ID');
         $order       = $this->request->getRequestParam('order', 'DESC');
         $month_range = $this->request->getRequestParam('month_range');
@@ -1957,10 +1957,10 @@ 
         $start_formats = EEM_Datetime::instance()->get_formats_for('DTT_EVT_start');
         if ($month_range) {
             $DateTime = new DateTime(
-                $year_r . '-' . $month_r . '-01 00:00:00',
+                $year_r.'-'.$month_r.'-01 00:00:00',
                 new DateTimeZone('UTC')
             );
-            $start    = $DateTime->getTimestamp();
+            $start = $DateTime->getTimestamp();
             // set the datetime to be the end of the month
             $DateTime->setDate(
                 $year_r,
@@ -1985,11 +1985,11 @@ 
                                                         ->format(implode(' ', $start_formats));
             $where['Datetime.DTT_EVT_start'] = ['BETWEEN', [$start, $end]];
         }
-        if (! EE_Registry::instance()->CAP->current_user_can('ee_read_others_events', 'get_events')) {
+        if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_others_events', 'get_events')) {
             $where['EVT_wp_user'] = get_current_user_id();
         } else {
-            if (! isset($where['status'])) {
-                if (! EE_Registry::instance()->CAP->current_user_can('ee_read_private_events', 'get_events')) {
+            if ( ! isset($where['status'])) {
+                if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_private_events', 'get_events')) {
                     $where['OR'] = [
                         'status*restrict_private' => ['!=', 'private'],
                         'AND'                     => [
@@ -2011,7 +2011,7 @@ 
         // search query handling
         $search_term = $this->request->getRequestParam('s');
         if ($search_term) {
-            $search_term = '%' . $search_term . '%';
+            $search_term = '%'.$search_term.'%';
             $where['OR'] = [
                 'EVT_name'       => ['LIKE', $search_term],
                 'EVT_desc'       => ['LIKE', $search_term],
@@ -2119,7 +2119,7 @@ 
             // clean status
             $event_status = sanitize_key($event_status);
             // grab status
-            if (! empty($event_status)) {
+            if ( ! empty($event_status)) {
                 $success = $this->_change_event_status($EVT_ID, $event_status);
             } else {
                 $success = false;
@@ -2159,7 +2159,7 @@ 
         // clean status
         $event_status = sanitize_key($event_status);
         // grab status
-        if (! empty($event_status)) {
+        if ( ! empty($event_status)) {
             $success = true;
             // determine the event id and set to array.
             $EVT_IDs = $this->request->getRequestParam('EVT_IDs', [], 'int', true);
@@ -2205,7 +2205,7 @@ 
     private function _change_event_status($EVT_ID = 0, $event_status = '')
     {
         // grab event id
-        if (! $EVT_ID) {
+        if ( ! $EVT_ID) {
             $msg = esc_html__(
                 'An error occurred. No Event ID or an invalid Event ID was received.',
                 'event_espresso'
@@ -2242,7 +2242,7 @@ 
         // use class to change status
         $this->_cpt_model_obj->set_status($event_status);
         $success = $this->_cpt_model_obj->save();
-        if (! $success) {
+        if ( ! $success) {
             $msg = sprintf(esc_html__('An error occurred. The event could not be %s.', 'event_espresso'), $action);
             EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
@@ -2300,7 +2300,7 @@ 
      */
     protected function getModelObjNodeGroupPersister()
     {
-        if (! $this->model_obj_node_group_persister instanceof NodeGroupDao) {
+        if ( ! $this->model_obj_node_group_persister instanceof NodeGroupDao) {
             $this->model_obj_node_group_persister =
                 $this->getLoader()->load('\EventEspresso\core\services\orm\tree_traversal\NodeGroupDao');
         }
@@ -2610,7 +2610,7 @@ 
                                                 . esc_html__(
                                                     'Template Settings is a feature that is only available in the premium version of Event Espresso 4 which is available with a support license purchase on EventEspresso.com. Template Settings allow you to configure some of the appearance options for both the Event List and Event Details pages.',
                                                     'event_espresso'
-                                                ) . '</strong>';
+                                                ).'</strong>';
         $this->display_admin_caf_preview_page('template_settings_tab');
     }
 
@@ -2631,11 +2631,11 @@ 
         $this->_set_empty_category_object();
         // only set if we've got an id
         $category_ID = $this->request->getRequestParam('EVT_CAT_ID', 0, 'int');
-        if (! $category_ID) {
+        if ( ! $category_ID) {
             return;
         }
         $term = get_term($category_ID, EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY);
-        if (! empty($term)) {
+        if ( ! empty($term)) {
             $this->_category->category_name       = $term->name;
             $this->_category->category_identifier = $term->slug;
             $this->_category->category_desc       = $term->description;
@@ -2739,7 +2739,7 @@ 
             $category_select_values,
             $this->_category->parent
         );
-        $template_args   = [
+        $template_args = [
             'category'                 => $this->_category,
             'category_select'          => $category_select,
             'unique_id_info_help_link' => $this->_get_help_tab_link('unique_id_info'),
@@ -2747,7 +2747,7 @@ 
             'disable'                  => '',
             'disabled_message'         => false,
         ];
-        $template        = EVENTS_TEMPLATE_PATH . 'event_category_details.template.php';
+        $template = EVENTS_TEMPLATE_PATH.'event_category_details.template.php';
         return EEH_Template::display_template($template, $template_args, true);
     }
 
@@ -2837,7 +2837,7 @@ 
         $insert_ids = $update
             ? wp_update_term($category_ID, EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY, $term_args)
             : wp_insert_term($category_name, EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY, $term_args);
-        if (! is_array($insert_ids)) {
+        if ( ! is_array($insert_ids)) {
             $msg = esc_html__(
                 'An error occurred and the category has not been saved to the database.',
                 'event_espresso'
@@ -2873,7 +2873,7 @@ 
         $where       = ['taxonomy' => EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY];
         $search_term = $this->request->getRequestParam('s');
         if ($search_term) {
-            $search_term = '%' . $search_term . '%';
+            $search_term = '%'.$search_term.'%';
             $where['OR'] = [
                 'Term.name'   => ['LIKE', $search_term],
                 'description' => ['LIKE', $search_term],
@@ -2882,7 +2882,7 @@ 
         $query_params = [
             $where,
             'order_by'   => [$orderby => $order],
-            'limit'      => $limit . ',' . $per_page,
+            'limit'      => $limit.','.$per_page,
             'force_join' => ['Term'],
         ];
         return $count

admin_pages/messages/Messages_Admin_Page.core.php

Indentation +4650 added lines, -4650 removed lines

@@ -17,2690 +17,2690 @@ 
  */
 class Messages_Admin_Page extends EE_Admin_Page
 {
-    /**
-     * @var EEM_Message
-     */
-    private $MSG_MODEL;
-
-    /**
-     * @var EEM_Message_Template
-     */
-    private $MTP_MODEL;
-
-    /**
-     * @var EEM_Message_Template_Group
-     */
-    private $MTG_MODEL;
-
-    /**
-     * @var EE_Message_Resource_Manager $_message_resource_manager
-     */
-    protected $_message_resource_manager;
-
-    /**
-     * @var string
-     */
-    protected $_active_message_type_name = '';
-
-    /**
-     * @var string
-     */
-    protected $_active_messenger_name = '';
-
-    /**
-     * @var EE_messenger $_active_messenger
-     */
-    protected $_active_messenger;
-
-    protected $_activate_meta_box_type;
-
-    protected $_current_message_meta_box;
-
-    protected $_current_message_meta_box_object;
-
-    protected $_context_switcher;
-
-    protected $_shortcodes           = [];
-
-    protected $_active_messengers    = [];
-
-    protected $_active_message_types = [];
-
-    /**
-     * @var EE_Message_Template_Group $_message_template_group
-     */
-    protected $_message_template_group;
-
-    protected $_m_mt_settings = [];
-
-
-    /**
-     * This is set via the _set_message_template_group method and holds whatever the template pack for the group is.
-     * IF there is no group then it gets automatically set to the Default template pack.
-     *
-     * @since 4.5.0
-     *
-     * @var EE_Messages_Template_Pack
-     */
-    protected $_template_pack;
-
-
-    /**
-     * This is set via the _set_message_template_group method and holds whatever the template pack variation for the
-     * group is.  If there is no group then it automatically gets set to default.
-     *
-     * @since 4.5.0
-     *
-     * @var string
-     */
-    protected $_variation;
-
-
-    /**
-     * @param bool $routing
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function __construct($routing = true)
-    {
-        // make sure messages autoloader is running
-        EED_Messages::set_autoloaders();
-        parent::__construct($routing);
-    }
-
-
-    /**
-     * @return EEM_Message
-     * @throws EE_Error
-     */
-    public function getMsgModel()
-    {
-        if (! $this->MSG_MODEL instanceof EEM_Message) {
-            $this->MSG_MODEL = EEM_Message::instance();
-        }
-        return $this->MSG_MODEL;
-    }
-
-
-    /**
-     * @return EEM_Message_Template
-     * @throws EE_Error
-     */
-    public function getMtpModel()
-    {
-        if (! $this->MTP_MODEL instanceof EEM_Message_Template) {
-            $this->MTP_MODEL = EEM_Message_Template::instance();
-        }
-        return $this->MTP_MODEL;
-    }
-
-
-    /**
-     * @return EEM_Message_Template_Group
-     * @throws EE_Error
-     */
-    public function getMtgModel()
-    {
-        if (! $this->MTG_MODEL instanceof EEM_Message_Template_Group) {
-            $this->MTG_MODEL = EEM_Message_Template_Group::instance();
-        }
-        return $this->MTG_MODEL;
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _init_page_props()
-    {
-        $this->page_slug        = EE_MSG_PG_SLUG;
-        $this->page_label       = esc_html__('Messages Settings', 'event_espresso');
-        $this->_admin_base_url  = EE_MSG_ADMIN_URL;
-        $this->_admin_base_path = EE_MSG_ADMIN;
-
-        $messenger    = $this->request->getRequestParam('messenger', '');
-        $message_type = $this->request->getRequestParam('message_type', '');
-        $this->_active_messenger_name    = $this->request->getRequestParam('MTP_messenger', $messenger);
-        $this->_active_message_type_name = $this->request->getRequestParam('MTP_message_type', $message_type);
-
-        $this->_load_message_resource_manager();
-    }
-
-
-    /**
-     * loads messenger objects into the $_active_messengers property (so we can access the needed methods)
-     *
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    protected function _load_message_resource_manager()
-    {
-        $this->_message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-    }
-
-
-    /**
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @deprecated 4.9.9.rc.014
-     */
-    public function get_messengers_for_list_table()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__(
-                    'This method is no longer in use.  There is no replacement for it. The method was used to generate a set of values for use in creating a messenger filter dropdown which is now generated differently via %s',
-                    'event_espresso'
-                ),
-                'Messages_Admin_Page::get_messengers_select_input()'
-            ),
-            '4.9.9.rc.014'
-        );
-
-        $m_values          = [];
-        $active_messengers = $this->getMsgModel()->get_all(['group_by' => 'MSG_messenger']);
-        // setup messengers for selects
-        $i = 1;
-        foreach ($active_messengers as $active_messenger) {
-            if ($active_messenger instanceof EE_Message) {
-                $m_values[ $i ]['id']   = $active_messenger->messenger();
-                $m_values[ $i ]['text'] = ucwords($active_messenger->messenger_label());
-                $i++;
-            }
-        }
-
-        return $m_values;
-    }
-
-
-    /**
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @deprecated 4.9.9.rc.014
-     */
-    public function get_message_types_for_list_table()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__(
-                    'This method is no longer in use.  There is no replacement for it. The method was used to generate a set of values for use in creating a message type filter dropdown which is now generated differently via %s',
-                    'event_espresso'
-                ),
-                'Messages_Admin_Page::get_message_types_select_input()'
-            ),
-            '4.9.9.rc.014'
-        );
-
-        $mt_values       = [];
-        $active_messages = $this->getMsgModel()->get_all(['group_by' => 'MSG_message_type']);
-        $i               = 1;
-        foreach ($active_messages as $active_message) {
-            if ($active_message instanceof EE_Message) {
-                $mt_values[ $i ]['id']   = $active_message->message_type();
-                $mt_values[ $i ]['text'] = ucwords($active_message->message_type_label());
-                $i++;
-            }
-        }
-
-        return $mt_values;
-    }
-
-
-    /**
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @deprecated 4.9.9.rc.014
-     */
-    public function get_contexts_for_message_types_for_list_table()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__(
-                    'This method is no longer in use.  There is no replacement for it. The method was used to generate a set of values for use in creating a message type context filter dropdown which is now generated differently via %s',
-                    'event_espresso'
-                ),
-                'Messages_Admin_Page::get_contexts_for_message_types_select_input()'
-            ),
-            '4.9.9.rc.014'
-        );
-
-        $contexts                = [];
-        $active_message_contexts = $this->getMsgModel()->get_all(['group_by' => 'MSG_context']);
-        foreach ($active_message_contexts as $active_message) {
-            if ($active_message instanceof EE_Message) {
-                $message_type = $active_message->message_type_object();
-                if ($message_type instanceof EE_message_type) {
-                    $message_type_contexts = $message_type->get_contexts();
-                    foreach ($message_type_contexts as $context => $context_details) {
-                        $contexts[ $context ] = $context_details['label'];
-                    }
-                }
-            }
-        }
-
-        return $contexts;
-    }
-
-
-    /**
-     * Generate select input with provided messenger options array.
-     *
-     * @param array $messenger_options Array of messengers indexed by messenger slug and values are the messenger
-     *                                 labels.
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_messengers_select_input($messenger_options)
-    {
-        // if empty or just one value then just return an empty string
-        if (
-            empty($messenger_options)
-            || ! is_array($messenger_options)
-            || count($messenger_options) === 1
-        ) {
-            return '';
-        }
-        // merge in default
-        $messenger_options = array_merge(
-            ['none_selected' => esc_html__('Show All Messengers', 'event_espresso')],
-            $messenger_options
-        );
-        $input             = new EE_Select_Input(
-            $messenger_options,
-            [
-                'html_name'  => 'ee_messenger_filter_by',
-                'html_id'    => 'ee_messenger_filter_by',
-                'html_class' => 'wide',
-                'default'    => $this->request->getRequestParam('ee_messenger_filter_by', 'none_selected', 'title'),
-            ]
-        );
-
-        return $input->get_html_for_input();
-    }
-
-
-    /**
-     * Generate select input with provided message type options array.
-     *
-     * @param array $message_type_options Array of message types indexed by message type slug, and values are the
-     *                                    message type labels
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_message_types_select_input($message_type_options)
-    {
-        // if empty or count of options is 1 then just return an empty string
-        if (
-            empty($message_type_options)
-            || ! is_array($message_type_options)
-            || count($message_type_options) === 1
-        ) {
-            return '';
-        }
-        // merge in default
-        $message_type_options = array_merge(
-            ['none_selected' => esc_html__('Show All Message Types', 'event_espresso')],
-            $message_type_options
-        );
-        $input                = new EE_Select_Input(
-            $message_type_options,
-            [
-                'html_name'  => 'ee_message_type_filter_by',
-                'html_id'    => 'ee_message_type_filter_by',
-                'html_class' => 'wide',
-                'default'    => $this->request->getRequestParam('ee_message_type_filter_by', 'none_selected', 'title'),
-            ]
-        );
-
-        return $input->get_html_for_input();
-    }
-
-
-    /**
-     * Generate select input with provide message type contexts array.
-     *
-     * @param array $context_options Array of message type contexts indexed by context slug, and values are the
-     *                               context label.
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_contexts_for_message_types_select_input($context_options)
-    {
-        // if empty or count of options is one then just return empty string
-        if (
-            empty($context_options)
-            || ! is_array($context_options)
-            || count($context_options) === 1
-        ) {
-            return '';
-        }
-        // merge in default
-        $context_options = array_merge(
-            ['none_selected' => esc_html__('Show all Contexts', 'event_espresso')],
-            $context_options
-        );
-        $input           = new EE_Select_Input(
-            $context_options,
-            [
-                'html_name'  => 'ee_context_filter_by',
-                'html_id'    => 'ee_context_filter_by',
-                'html_class' => 'wide',
-                'default'    => $this->request->getRequestParam('ee_context_filter_by', 'none_selected', 'title'),
-            ]
-        );
-
-        return $input->get_html_for_input();
-    }
-
-
-    protected function _ajax_hooks()
-    {
-        add_action('wp_ajax_activate_messenger', [$this, 'activate_messenger_toggle']);
-        add_action('wp_ajax_activate_mt', [$this, 'activate_mt_toggle']);
-        add_action('wp_ajax_ee_msgs_save_settings', [$this, 'save_settings']);
-        add_action('wp_ajax_ee_msgs_update_mt_form', [$this, 'update_mt_form']);
-        add_action('wp_ajax_switch_template_pack', [$this, 'switch_template_pack']);
-        add_action('wp_ajax_toggle_context_template', [$this, 'toggle_context_template']);
-    }
-
-
-    protected function _define_page_props()
-    {
-        $this->_admin_page_title = $this->page_label;
-        $this->_labels           = [
-            'buttons'    => [
-                'add'    => esc_html__('Add New Message Template', 'event_espresso'),
-                'edit'   => esc_html__('Edit Message Template', 'event_espresso'),
-                'delete' => esc_html__('Delete Message Template', 'event_espresso'),
-            ],
-            'publishbox' => esc_html__('Update Actions', 'event_espresso'),
-        ];
-    }
-
-
-    /**
-     *        an array for storing key => value pairs of request actions and their corresponding methods
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_page_routes()
-    {
-        $GRP_ID = $this->request->getRequestParam('GRP_ID', 0, 'int');
-        $GRP_ID = $this->request->getRequestParam('id', $GRP_ID, 'int');
-        $MSG_ID = $this->request->getRequestParam('MSG_ID', 0, 'int');
-
-        $this->_page_routes = [
-            'default'                          => [
-                'func'       => '_message_queue_list_table',
-                'capability' => 'ee_read_global_messages',
-            ],
-            'global_mtps'                      => [
-                'func'       => '_ee_default_messages_overview_list_table',
-                'capability' => 'ee_read_global_messages',
-            ],
-            'custom_mtps'                      => [
-                'func'       => '_custom_mtps_preview',
-                'capability' => 'ee_read_messages',
-            ],
-            'add_new_message_template'         => [
-                'func'       => 'add_message_template',
-                'capability' => 'ee_edit_messages',
-                'noheader'   => true,
-            ],
-            'edit_message_template'            => [
-                'func'       => '_edit_message_template',
-                'capability' => 'ee_edit_message',
-                'obj_id'     => $GRP_ID,
-            ],
-            'preview_message'                  => [
-                'func'               => '_preview_message',
-                'capability'         => 'ee_read_message',
-                'obj_id'             => $GRP_ID,
-                'noheader'           => true,
-                'headers_sent_route' => 'display_preview_message',
-            ],
-            'display_preview_message'          => [
-                'func'       => '_display_preview_message',
-                'capability' => 'ee_read_message',
-                'obj_id'     => $GRP_ID,
-            ],
-            'insert_message_template'          => [
-                'func'       => '_insert_or_update_message_template',
-                'capability' => 'ee_edit_messages',
-                'args'       => ['new' => true],
-                'noheader'   => true,
-            ],
-            'update_message_template'          => [
-                'func'       => '_insert_or_update_message_template',
-                'capability' => 'ee_edit_message',
-                'obj_id'     => $GRP_ID,
-                'args'       => ['new' => false],
-                'noheader'   => true,
-            ],
-            'trash_message_template'           => [
-                'func'       => '_trash_or_restore_message_template',
-                'capability' => 'ee_delete_message',
-                'obj_id'     => $GRP_ID,
-                'args'       => ['trash' => true, 'all' => true],
-                'noheader'   => true,
-            ],
-            'trash_message_template_context'   => [
-                'func'       => '_trash_or_restore_message_template',
-                'capability' => 'ee_delete_message',
-                'obj_id'     => $GRP_ID,
-                'args'       => ['trash' => true],
-                'noheader'   => true,
-            ],
-            'restore_message_template'         => [
-                'func'       => '_trash_or_restore_message_template',
-                'capability' => 'ee_delete_message',
-                'obj_id'     => $GRP_ID,
-                'args'       => ['trash' => false, 'all' => true],
-                'noheader'   => true,
-            ],
-            'restore_message_template_context' => [
-                'func'       => '_trash_or_restore_message_template',
-                'capability' => 'ee_delete_message',
-                'obj_id'     => $GRP_ID,
-                'args'       => ['trash' => false],
-                'noheader'   => true,
-            ],
-            'delete_message_template'          => [
-                'func'       => '_delete_message_template',
-                'capability' => 'ee_delete_message',
-                'obj_id'     => $GRP_ID,
-                'noheader'   => true,
-            ],
-            'reset_to_default'                 => [
-                'func'       => '_reset_to_default_template',
-                'capability' => 'ee_edit_message',
-                'obj_id'     => $GRP_ID,
-                'noheader'   => true,
-            ],
-            'settings'                         => [
-                'func'       => '_settings',
-                'capability' => 'manage_options',
-            ],
-            'update_global_settings'           => [
-                'func'       => '_update_global_settings',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ],
-            'generate_now'                     => [
-                'func'       => '_generate_now',
-                'capability' => 'ee_send_message',
-                'noheader'   => true,
-            ],
-            'generate_and_send_now'            => [
-                'func'       => '_generate_and_send_now',
-                'capability' => 'ee_send_message',
-                'noheader'   => true,
-            ],
-            'queue_for_resending'              => [
-                'func'       => '_queue_for_resending',
-                'capability' => 'ee_send_message',
-                'noheader'   => true,
-            ],
-            'send_now'                         => [
-                'func'       => '_send_now',
-                'capability' => 'ee_send_message',
-                'noheader'   => true,
-            ],
-            'delete_ee_message'                => [
-                'func'       => '_delete_ee_messages',
-                'capability' => 'ee_delete_messages',
-                'noheader'   => true,
-            ],
-            'delete_ee_messages'               => [
-                'func'       => '_delete_ee_messages',
-                'capability' => 'ee_delete_messages',
-                'noheader'   => true,
-                'obj_id'     => $MSG_ID,
-            ],
-        ];
-    }
-
-
-    protected function _set_page_config()
-    {
-        $this->_page_config = [
-            'default'                  => [
-                'nav'           => [
-                    'label' => esc_html__('Message Activity', 'event_espresso'),
-                    'icon' => 'dashicons-email',
-                    'order' => 10,
-                ],
-                'list_table'    => 'EE_Message_List_Table',
-                // 'qtips' => array( 'EE_Message_List_Table_Tips' ),
-                'require_nonce' => false,
-            ],
-            'global_mtps'              => [
-                'nav'           => [
-                    'label' => esc_html__('Default Message Templates', 'event_espresso'),
-                    'icon' => 'dashicons-layout',
-                    'order' => 20,
-                ],
-                'list_table'    => 'Messages_Template_List_Table',
-                'help_tabs'     => [
-                    'messages_overview_help_tab'                                => [
-                        'title'    => esc_html__('Messages Overview', 'event_espresso'),
-                        'filename' => 'messages_overview',
-                    ],
-                    'messages_overview_messages_table_column_headings_help_tab' => [
-                        'title'    => esc_html__('Messages Table Column Headings', 'event_espresso'),
-                        'filename' => 'messages_overview_table_column_headings',
-                    ],
-                    'messages_overview_messages_filters_help_tab'               => [
-                        'title'    => esc_html__('Message Filters', 'event_espresso'),
-                        'filename' => 'messages_overview_filters',
-                    ],
-                    'messages_overview_messages_views_help_tab'                 => [
-                        'title'    => esc_html__('Message Views', 'event_espresso'),
-                        'filename' => 'messages_overview_views',
-                    ],
-                    'message_overview_message_types_help_tab'                   => [
-                        'title'    => esc_html__('Message Types', 'event_espresso'),
-                        'filename' => 'messages_overview_types',
-                    ],
-                    'messages_overview_messengers_help_tab'                     => [
-                        'title'    => esc_html__('Messengers', 'event_espresso'),
-                        'filename' => 'messages_overview_messengers',
-                    ],
-                ],
-                'require_nonce' => false,
-            ],
-            'custom_mtps'              => [
-                'nav'           => [
-                    'label' => esc_html__('Custom Message Templates', 'event_espresso'),
-                    'icon' => 'dashicons-admin-customizer',
-                    'order' => 30,
-                ],
-                'help_tabs'     => [],
-                'require_nonce' => false,
-            ],
-            'add_new_message_template' => [
-                'nav'           => [
-                    'label'      => esc_html__('Add New Message Templates', 'event_espresso'),
-                    'icon' => 'dashicons-plus-alt',
-                    'order'      => 5,
-                    'persistent' => false,
-                ],
-                'require_nonce' => false,
-            ],
-            'edit_message_template'    => [
-                'labels'        => [
-                    'buttons'    => [
-                        'reset' => esc_html__('Reset Templates', 'event_espresso'),
-                    ],
-                    'publishbox' => esc_html__('Update Actions', 'event_espresso'),
-                ],
-                'nav'           => [
-                    'label'      => esc_html__('Edit Message Templates', 'event_espresso'),
-                    'icon' => 'dashicons-edit-large',
-                    'order'      => 5,
-                    'persistent' => false,
-                    'url'        => '',
-                ],
-                'metaboxes'     => ['_publish_post_box', '_register_edit_meta_boxes'],
-                'has_metaboxes' => true,
-                'help_tabs'     => [
-                    'edit_message_template'            => [
-                        'title'    => esc_html__('Message Template Editor', 'event_espresso'),
-                        'callback' => 'edit_message_template_help_tab',
-                    ],
-                    'message_templates_help_tab'       => [
-                        'title'    => esc_html__('Message Templates', 'event_espresso'),
-                        'filename' => 'messages_templates',
-                    ],
-                    'message_template_shortcodes'      => [
-                        'title'    => esc_html__('Message Shortcodes', 'event_espresso'),
-                        'callback' => 'message_template_shortcodes_help_tab',
-                    ],
-                    'message_preview_help_tab'         => [
-                        'title'    => esc_html__('Message Preview', 'event_espresso'),
-                        'filename' => 'messages_preview',
-                    ],
-                    'messages_overview_other_help_tab' => [
-                        'title'    => esc_html__('Messages Other', 'event_espresso'),
-                        'filename' => 'messages_overview_other',
-                    ],
-                ],
-                'require_nonce' => false,
-            ],
-            'display_preview_message'  => [
-                'nav'           => [
-                    'label'      => esc_html__('Message Preview', 'event_espresso'),
-                    'icon' => 'dashicons-visibility-bar',
-                    'order'      => 5,
-                    'url'        => '',
-                    'persistent' => false,
-                ],
-                'help_tabs'     => [
-                    'preview_message' => [
-                        'title'    => esc_html__('About Previews', 'event_espresso'),
-                        'callback' => 'preview_message_help_tab',
-                    ],
-                ],
-                'require_nonce' => false,
-            ],
-            'settings'                 => [
-                'nav'           => [
-                    'label' => esc_html__('Settings', 'event_espresso'),
-                    'icon' => 'dashicons-admin-generic',
-                    'order' => 40,
-                ],
-                'metaboxes'     => ['_messages_settings_metaboxes'],
-                'help_tabs'     => [
-                    'messages_settings_help_tab'               => [
-                        'title'    => esc_html__('Messages Settings', 'event_espresso'),
-                        'filename' => 'messages_settings',
-                    ],
-                    'messages_settings_message_types_help_tab' => [
-                        'title'    => esc_html__('Activating / Deactivating Message Types', 'event_espresso'),
-                        'filename' => 'messages_settings_message_types',
-                    ],
-                    'messages_settings_messengers_help_tab'    => [
-                        'title'    => esc_html__('Activating / Deactivating Messengers', 'event_espresso'),
-                        'filename' => 'messages_settings_messengers',
-                    ],
-                ],
-                'require_nonce' => false,
-            ],
-        ];
-    }
-
-
-    protected function _add_screen_options()
-    {
-        // todo
-    }
-
-
-    protected function _add_screen_options_global_mtps()
-    {
-        /**
-         * Note: the reason for the value swap here on $this->_admin_page_title is because $this->_per_page_screen_options
-         * uses the $_admin_page_title property and we want different outputs in the different spots.
-         */
-        $page_title              = $this->_admin_page_title;
-        $this->_admin_page_title = esc_html__('Global Message Templates', 'event_espresso');
-        $this->_per_page_screen_option();
-        $this->_admin_page_title = $page_title;
-    }
-
-
-    protected function _add_screen_options_default()
-    {
-        $this->_admin_page_title = esc_html__('Message Activity', 'event_espresso');
-        $this->_per_page_screen_option();
-    }
-
-
-    // none of the below group are currently used for Messages
-    protected function _add_feature_pointers()
-    {
-    }
-
-
-    public function admin_init()
-    {
-    }
-
-
-    public function admin_notices()
-    {
-    }
-
-
-    public function admin_footer_scripts()
-    {
-    }
-
-
-    public function messages_help_tab()
-    {
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_help_tab.template.php');
-    }
-
-
-    public function messengers_help_tab()
-    {
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messenger_help_tab.template.php');
-    }
-
-
-    public function message_types_help_tab()
-    {
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_message_type_help_tab.template.php');
-    }
-
-
-    public function messages_overview_help_tab()
-    {
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_overview_help_tab.template.php');
-    }
-
-
-    public function message_templates_help_tab()
-    {
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_message_templates_help_tab.template.php');
-    }
-
-
-    public function edit_message_template_help_tab()
-    {
-        $args['img1'] = '<img src="' . EE_MSG_ASSETS_URL . 'images/editor.png' . '" alt="'
-                        . esc_attr__('Editor Title', 'event_espresso')
-                        . '" />';
-        $args['img2'] = '<img src="' . EE_MSG_ASSETS_URL . 'images/switch-context.png' . '" alt="'
-                        . esc_attr__('Context Switcher and Preview', 'event_espresso')
-                        . '" />';
-        $args['img3'] = '<img class="left" src="' . EE_MSG_ASSETS_URL . 'images/form-fields.png' . '" alt="'
-                        . esc_attr__('Message Template Form Fields', 'event_espresso')
-                        . '" />';
-        $args['img4'] = '<img class="right" src="' . EE_MSG_ASSETS_URL . 'images/shortcodes-metabox.png' . '" alt="'
-                        . esc_attr__('Shortcodes Metabox', 'event_espresso')
-                        . '" />';
-        $args['img5'] = '<img class="right" src="' . EE_MSG_ASSETS_URL . 'images/publish-meta-box.png' . '" alt="'
-                        . esc_attr__('Publish Metabox', 'event_espresso')
-                        . '" />';
-        EEH_Template::display_template(
-            EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_templates_editor_help_tab.template.php',
-            $args
-        );
-    }
-
-
-    /**
-     * @throws ReflectionException
-     * @throws EE_Error
-     */
-    public function message_template_shortcodes_help_tab()
-    {
-        $this->_set_shortcodes();
-        $args['shortcodes'] = $this->_shortcodes;
-        EEH_Template::display_template(
-            EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_shortcodes_help_tab.template.php',
-            $args
-        );
-    }
-
-
-    public function preview_message_help_tab()
-    {
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_preview_help_tab.template.php');
-    }
-
-
-    public function settings_help_tab()
-    {
-        $args['img1'] = '<img class="inline-text" src="' . EE_MSG_ASSETS_URL . 'images/email-tab-active.png'
-                        . '" alt="' . esc_attr__('Active Email Tab', 'event_espresso') . '" />';
-        $args['img2'] = '<img class="inline-text" src="' . EE_MSG_ASSETS_URL . 'images/email-tab-inactive.png'
-                        . '" alt="' . esc_attr__('Inactive Email Tab', 'event_espresso') . '" />';
-        $args['img3'] = '<div class="switch">'
-                        . '<input class="ee-on-off-toggle ee-toggle-round-flat"'
-                        . ' type="checkbox" checked>'
-                        . '<label for="ee-on-off-toggle-on"></label>'
-                        . '</div>';
-        $args['img4'] = '<div class="switch">'
-                        . '<input class="ee-on-off-toggle ee-toggle-round-flat"'
-                        . ' type="checkbox">'
-                        . '<label for="ee-on-off-toggle-on"></label>'
-                        . '</div>';
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_settings_help_tab.template.php', $args);
-    }
-
-
-    public function load_scripts_styles()
-    {
-        wp_register_style('espresso_ee_msg', EE_MSG_ASSETS_URL . 'ee_message_admin.css', EVENT_ESPRESSO_VERSION);
-        wp_enqueue_style('espresso_ee_msg');
-
-        wp_register_script(
-            'ee-messages-settings',
-            EE_MSG_ASSETS_URL . 'ee-messages-settings.js',
-            ['jquery-ui-droppable', 'ee-serialize-full-array'],
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_register_script(
-            'ee-msg-list-table-js',
-            EE_MSG_ASSETS_URL . 'ee_message_admin_list_table.js',
-            ['ee-dialog'],
-            EVENT_ESPRESSO_VERSION
-        );
-    }
-
-
-    public function load_scripts_styles_default()
-    {
-        wp_enqueue_script('ee-msg-list-table-js');
-    }
-
-
-    public function wp_editor_css($mce_css)
-    {
-        // if we're on the edit_message_template route
-        if ($this->_req_action === 'edit_message_template' && $this->_active_messenger instanceof EE_messenger) {
-            $message_type_name = $this->_active_message_type_name;
-
-            // we're going to REPLACE the existing mce css
-            // we need to get the css file location from the active messenger
-            $mce_css = $this->_active_messenger->get_variation(
-                $this->_template_pack,
-                $message_type_name,
-                true,
-                'wpeditor',
-                $this->_variation
-            );
-        }
-
-        return $mce_css;
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function load_scripts_styles_edit_message_template()
-    {
-
-        $this->_set_shortcodes();
-
-        EE_Registry::$i18n_js_strings['confirm_default_reset']        = sprintf(
-            esc_html__(
-                'Are you sure you want to reset the %s %s message templates?  Remember continuing will reset the templates for all contexts in this messenger and message type group.',
-                'event_espresso'
-            ),
-            $this->_message_template_group->messenger_obj()->label['singular'],
-            $this->_message_template_group->message_type_obj()->label['singular']
-        );
-        EE_Registry::$i18n_js_strings['confirm_switch_template_pack'] = esc_html__(
-            'Switching the template pack for a messages template will reset the content for the template so the new layout is loaded.  Any custom content in the existing template will be lost. Are you sure you wish to do this?',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['server_error']                 = esc_html__(
-            'An unknown error occurred on the server while attempting to process your request. Please refresh the page and try again or contact support.',
-            'event_espresso'
-        );
-
-        wp_register_script(
-            'ee_msgs_edit_js',
-            EE_MSG_ASSETS_URL . 'ee_message_editor.js',
-            ['jquery'],
-            EVENT_ESPRESSO_VERSION
-        );
-
-        wp_enqueue_script('ee_admin_js');
-        wp_enqueue_script('ee_msgs_edit_js');
-
-        // add in special css for tiny_mce
-        add_filter('mce_css', [$this, 'wp_editor_css']);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function load_scripts_styles_display_preview_message()
-    {
-        $this->_set_message_template_group();
-        if ($this->_active_messenger_name) {
-            $this->_active_messenger = $this->_message_resource_manager->get_active_messenger(
-                $this->_active_messenger_name
-            );
-        }
-
-        wp_enqueue_style(
-            'espresso_preview_css',
-            $this->_active_messenger->get_variation(
-                $this->_template_pack,
-                $this->_active_message_type_name,
-                true,
-                'preview',
-                $this->_variation
-            )
-        );
-    }
-
-
-    public function load_scripts_styles_settings()
-    {
-        wp_register_style(
-            'ee-message-settings',
-            EE_MSG_ASSETS_URL . 'ee_message_settings.css',
-            [],
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('ee-text-links');
-        wp_enqueue_style('ee-message-settings');
-        wp_enqueue_script('ee-messages-settings');
-    }
-
-
-    /**
-     * set views array for List Table
-     */
-    public function _set_list_table_views_global_mtps()
-    {
-        $this->_views = [
-            'in_use' => [
-                'slug'  => 'in_use',
-                'label' => esc_html__('In Use', 'event_espresso'),
-                'count' => 0,
-            ],
-        ];
-    }
-
-
-    /**
-     * Set views array for the Custom Template List Table
-     */
-    public function _set_list_table_views_custom_mtps()
-    {
-        $this->_set_list_table_views_global_mtps();
-        $this->_views['in_use']['bulk_action'] = [
-            'trash_message_template' => esc_html__('Move to Trash', 'event_espresso'),
-        ];
-    }
-
-
-    /**
-     * set views array for message queue list table
-     *
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function _set_list_table_views_default()
-    {
-        EE_Registry::instance()->load_helper('Template');
-
-        $common_bulk_actions = EE_Registry::instance()->CAP->current_user_can(
-            'ee_send_message',
-            'message_list_table_bulk_actions'
-        )
-            ? [
-                'generate_now'          => esc_html__('Generate Now', 'event_espresso'),
-                'generate_and_send_now' => esc_html__('Generate and Send Now', 'event_espresso'),
-                'queue_for_resending'   => esc_html__('Queue for Resending', 'event_espresso'),
-                'send_now'              => esc_html__('Send Now', 'event_espresso'),
-            ]
-            : [];
-
-        $delete_bulk_action = EE_Registry::instance()->CAP->current_user_can(
-            'ee_delete_messages',
-            'message_list_table_bulk_actions'
-        )
-            ? ['delete_ee_messages' => esc_html__('Delete Messages', 'event_espresso')]
-            : [];
-
-
-        $this->_views = [
-            'all' => [
-                'slug'        => 'all',
-                'label'       => esc_html__('All', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array_merge($common_bulk_actions, $delete_bulk_action),
-            ],
-        ];
-
-
-        foreach ($this->getMsgModel()->all_statuses() as $status) {
-            if ($status === EEM_Message::status_debug_only && ! EEM_Message::debug()) {
-                continue;
-            }
-            $status_bulk_actions = $common_bulk_actions;
-            // unset bulk actions not applying to status
-            if (! empty($status_bulk_actions)) {
-                switch ($status) {
-                    case EEM_Message::status_idle:
-                    case EEM_Message::status_resend:
-                        $status_bulk_actions['send_now'] = $common_bulk_actions['send_now'];
-                        break;
-
-                    case EEM_Message::status_failed:
-                    case EEM_Message::status_debug_only:
-                    case EEM_Message::status_messenger_executing:
-                        $status_bulk_actions = [];
-                        break;
-
-                    case EEM_Message::status_incomplete:
-                        unset($status_bulk_actions['queue_for_resending'], $status_bulk_actions['send_now']);
-                        break;
-
-                    case EEM_Message::status_retry:
-                    case EEM_Message::status_sent:
-                        unset($status_bulk_actions['generate_now'], $status_bulk_actions['generate_and_send_now']);
-                        break;
-                }
-            }
-
-            // skip adding messenger executing status to views because it will be included with the Failed view.
-            if ($status === EEM_Message::status_messenger_executing) {
-                continue;
-            }
-
-            $this->_views[ strtolower($status) ] = [
-                'slug'        => strtolower($status),
-                'label'       => EEH_Template::pretty_status($status, false, 'sentence'),
-                'count'       => 0,
-                'bulk_action' => array_merge($status_bulk_actions, $delete_bulk_action),
-            ];
-        }
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    protected function _ee_default_messages_overview_list_table()
-    {
-        $this->_admin_page_title = esc_html__('Default Message Templates', 'event_espresso');
-        $this->display_admin_list_table_page_with_no_sidebar();
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _message_queue_list_table()
-    {
-        $this->_search_btn_label                   = esc_html__('Message Activity', 'event_espresso');
-        $this->_template_args['per_column']        = 6;
-        $this->_template_args['after_list_table']  = $this->_display_legend($this->_message_legend_items());
-        $message_results = trim(EEM_Message::instance()->get_pretty_label_for_results());
-        $this->_template_args['before_list_table'] = ! empty($message_results) ? "<h3>{$message_results}</h3>" : '';
-        $this->display_admin_list_table_page_with_no_sidebar();
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    protected function _message_legend_items()
-    {
-
-        $action_css_classes = EEH_MSG_Template::get_message_action_icons();
-        $action_items       = [];
-
-        foreach ($action_css_classes as $action_item => $action_details) {
-            if ($action_item === 'see_notifications_for') {
-                continue;
-            }
-            $action_items[ $action_item ] = [
-                'class' => $action_details['css_class'],
-                'desc'  => $action_details['label'],
-            ];
-        }
-
-        /** @var array $status_items status legend setup */
-        $status_items = [
-            'sent_status'                => [
-                'class' => 'ee-status-legend ee-status-bg--' . EEM_Message::status_sent,
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_sent, false, 'sentence'),
-            ],
-            'idle_status'                => [
-                'class' => 'ee-status-legend ee-status-bg--' . EEM_Message::status_idle,
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_idle, false, 'sentence'),
-            ],
-            'failed_status'              => [
-                'class' => 'ee-status-legend ee-status-bg--' . EEM_Message::status_failed,
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_failed, false, 'sentence'),
-            ],
-            'messenger_executing_status' => [
-                'class' => 'ee-status-legend ee-status-bg--' . EEM_Message::status_messenger_executing,
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_messenger_executing, false, 'sentence'),
-            ],
-            'resend_status'              => [
-                'class' => 'ee-status-legend ee-status-bg--' . EEM_Message::status_resend,
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_resend, false, 'sentence'),
-            ],
-            'incomplete_status'          => [
-                'class' => 'ee-status-legend ee-status-bg--' . EEM_Message::status_incomplete,
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_incomplete, false, 'sentence'),
-            ],
-            'retry_status'               => [
-                'class' => 'ee-status-legend ee-status-bg--' . EEM_Message::status_retry,
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_retry, false, 'sentence'),
-            ],
-        ];
-        if (EEM_Message::debug()) {
-            $status_items['debug_only_status'] = [
-                'class' => 'ee-status-legend ee-status-bg--' . EEM_Message::status_debug_only,
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_debug_only, false, 'sentence'),
-            ];
-        }
-
-        return array_merge($action_items, $status_items);
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    protected function _custom_mtps_preview()
-    {
-        $this->_admin_page_title              = esc_html__('Custom Message Templates (Preview)', 'event_espresso');
-        $this->_template_args['preview_img']  = '<img src="' . EE_MSG_ASSETS_URL . 'images/custom_mtps_preview.png"'
-                                                . ' alt="' . esc_attr__(
-                                                    'Preview Custom Message Templates screenshot',
-                                                    'event_espresso'
-                                                ) . '" />';
-        $this->_template_args['preview_text'] = '<strong>'
-                                                . esc_html__(
-                                                    'Custom Message Templates is a feature that is only available in the premium version of Event Espresso 4 which is available with a support license purchase on EventEspresso.com. With the Custom Message Templates feature, you are able to create custom message templates and assign them on a per-event basis.',
-                                                    'event_espresso'
-                                                )
-                                                . '</strong>';
-
-        $this->display_admin_caf_preview_page('custom_message_types', false);
-    }
-
-
-    /**
-     * get_message_templates
-     * This gets all the message templates for listing on the overview list.
-     *
-     * @access public
-     * @param int    $per_page the amount of templates groups to show per page
-     * @param string $type     the current _view we're getting templates for
-     * @param bool   $count    return count?
-     * @param bool   $all      disregard any paging info (get all data);
-     * @param bool   $global   whether to return just global (true) or custom templates (false)
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_message_templates(
-        $per_page = 10,
-        $type = 'in_use',
-        $count = false,
-        $all = false,
-        $global = true
-    ) {
-        $orderby = $this->request->getRequestParam('orderby', 'GRP_ID');
-        $this->request->setRequestParam('orderby', $orderby);
-
-        $order        = $this->request->getRequestParam('order', 'ASC');
-        $current_page = $this->request->getRequestParam('paged', 1, 'int');
-        $per_page     = $this->request->getRequestParam('perpage', $per_page, 'int');
-
-        $offset = ($current_page - 1) * $per_page;
-        $limit  = $all ? null : [$offset, $per_page];
-
-        // options will match what is in the _views array property
-        return $type === 'in_use'
-            ? $this->getMtgModel()->get_all_active_message_templates(
-                $orderby,
-                $order,
-                $limit,
-                $count,
-                $global,
-                true
-            )
-            : $this->getMtgModel()->get_all_trashed_grouped_message_templates(
-                $orderby,
-                $order,
-                $limit,
-                $count,
-                $global
-            );
-    }
-
-
-    /**
-     * filters etc might need a list of installed message_types
-     *
-     * @return array an array of message type objects
-     */
-    public function get_installed_message_types()
-    {
-        $installed_message_types = $this->_message_resource_manager->installed_message_types();
-        $installed               = [];
-
-        foreach ($installed_message_types as $message_type) {
-            $installed[ $message_type->name ] = $message_type;
-        }
-
-        return $installed;
-    }
-
-
-    /**
-     * This is used when creating a custom template. All Custom Templates start based off another template.
-     *
-     * @param string $message_type
-     * @param string $messenger
-     * @param string $GRP_ID
-     *
-     * @throws EE_error
-     * @throws ReflectionException
-     */
-    public function add_message_template($message_type = '', $messenger = '', $GRP_ID = '')
-    {
-        // set values override any request data
-        $message_type = ! empty($message_type) ? $message_type : $this->_active_message_type_name;
-        $messenger    = ! empty($messenger) ? $messenger : $this->_active_messenger_name;
-        $GRP_ID       = ! empty($GRP_ID) ? $GRP_ID : $this->request->getRequestParam('GRP_ID', 0, 'int');
-
-        // we need messenger and message type.  They should be coming from the event editor. If not here then return error
-        if (empty($message_type) || empty($messenger)) {
-            throw new EE_Error(
-                esc_html__(
-                    'Sorry, but we can\'t create new templates because we\'re missing the messenger or message type',
-                    'event_espresso'
-                )
-            );
-        }
-
-        // we need the GRP_ID for the template being used as the base for the new template
-        if (empty($GRP_ID)) {
-            throw new EE_Error(
-                esc_html__(
-                    'In order to create a custom message template the GRP_ID of the template being used as a base is needed',
-                    'event_espresso'
-                )
-            );
-        }
-
-        // let's just make sure the template gets generated!
-
-        // we need to reassign some variables for what the insert is expecting
-        $this->request->setRequestParam('MTP_messenger', $messenger);
-        $this->request->setRequestParam('MTP_message_type', $message_type);
-        $this->request->setRequestParam('GRP_ID', $GRP_ID);
-
-        $this->_insert_or_update_message_template(true);
-    }
-
-
-    /**
-     * @param string $message_type     message type slug
-     * @param string $messenger        messenger slug
-     * @param int    $GRP_ID           GRP_ID for the related message template group this new template will be based
-     *                                 off of.
-     * @throws EE_error
-     * @throws ReflectionException
-     * @deprecated 4.10.29.p
-     */
-    protected function _add_message_template($message_type, $messenger, $GRP_ID)
-    {
-        $this->add_message_template($message_type, $messenger, $GRP_ID);
-    }
-
-
-    /**
-     * _edit_message_template
-     *
-     * @access protected
-     * @return void
-     * @throws InvalidIdentifierException
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _edit_message_template()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $template_fields = '';
-        $sidebar_fields  = '';
-        // we filter the tinyMCE settings to remove the validation since message templates by their nature will not have
-        // valid html in the templates.
-        add_filter('tiny_mce_before_init', [$this, 'filter_tinymce_init'], 10, 2);
-
-        $GRP_ID = $this->request->getRequestParam('id', 0, 'int');
-        $EVT_ID = $this->request->getRequestParam('evt_id', 0, 'int');
-
-        $this->_set_shortcodes(); // this also sets the _message_template property.
-        $message_template_group = $this->_message_template_group;
-        $c_label                = $message_template_group->context_label();
-        $c_config               = $message_template_group->contexts_config();
-
-        reset($c_config);
-        $context = $this->request->getRequestParam('context', key($c_config));
-        $context = strtolower($context);
-
-        $action = empty($GRP_ID) ? 'insert_message_template' : 'update_message_template';
-
-        $edit_message_template_form_url = add_query_arg(
-            ['action' => $action, 'noheader' => true],
-            EE_MSG_ADMIN_URL
-        );
-
-        // set active messenger for this view
-        $this->_active_messenger         = $this->_message_resource_manager->get_active_messenger(
-            $message_template_group->messenger()
-        );
-        $this->_active_message_type_name = $message_template_group->message_type();
-
-
-        // Do we have any validation errors?
-        $validators = $this->_get_transient();
-        $v_fields   = ! empty($validators) ? array_keys($validators) : [];
-
-
-        // we need to assemble the title from Various details
-        $context_label = sprintf(
-            esc_html__('(%s %s)', 'event_espresso'),
-            $c_config[ $context ]['label'],
-            ucwords($c_label['label'])
-        );
-
-        $title = sprintf(
-            esc_html__(' %s %s Template %s', 'event_espresso'),
-            ucwords($message_template_group->messenger_obj()->label['singular']),
-            ucwords($message_template_group->message_type_obj()->label['singular']),
-            $context_label
-        );
-
-        $this->_template_args['GRP_ID']           = $GRP_ID;
-        $this->_template_args['message_template'] = $message_template_group;
-        $this->_template_args['is_extra_fields']  = false;
-
-
-        // let's get EEH_MSG_Template so we can get template form fields
-        $template_field_structure = EEH_MSG_Template::get_fields(
-            $message_template_group->messenger(),
-            $message_template_group->message_type()
-        );
-
-        if (! $template_field_structure) {
-            $template_field_structure = false;
-            $template_fields          = esc_html__(
-                'There was an error in assembling the fields for this display (you should see an error message)',
-                'event_espresso'
-            );
-        }
-
-
-        $message_templates = $message_template_group->context_templates();
-
-
-        // if we have the extra key.. then we need to remove the content index from the template_field_structure as it
-        // will get handled in the "extra" array.
-        if (is_array($template_field_structure[ $context ]) && isset($template_field_structure[ $context ]['extra'])) {
-            foreach ($template_field_structure[ $context ]['extra'] as $reference_field => $new_fields) {
-                unset($template_field_structure[ $context ][ $reference_field ]);
-            }
-        }
-
-        // let's loop through the template_field_structure and actually assemble the input fields!
-        if (! empty($template_field_structure)) {
-            foreach ($template_field_structure[ $context ] as $template_field => $field_setup_array) {
-                // if this is an 'extra' template field then we need to remove any existing fields that are keyed up in
-                // the extra array and reset them.
-                if ($template_field === 'extra') {
-                    $this->_template_args['is_extra_fields'] = true;
-                    foreach ($field_setup_array as $reference_field => $new_fields_array) {
-                        $message_template = $message_templates[ $context ][ $reference_field ];
-                        $content          = $message_template instanceof EE_Message_Template
-                            ? $message_template->get('MTP_content')
-                            : '';
-                        foreach ($new_fields_array as $extra_field => $extra_array) {
-                            // let's verify if we need this extra field via the shortcodes parameter.
-                            $continue = false;
-                            if (isset($extra_array['shortcodes_required'])) {
-                                foreach ((array) $extra_array['shortcodes_required'] as $shortcode) {
-                                    if (! array_key_exists($shortcode, $this->_shortcodes)) {
-                                        $continue = true;
-                                    }
-                                }
-                                if ($continue) {
-                                    continue;
-                                }
-                            }
-
-                            $field_id = $reference_field . '-' . $extra_field . '-content';
-
-                            $template_form_fields[ $field_id ]         = $extra_array;
-                            $template_form_fields[ $field_id ]['name'] = 'MTP_template_fields['
-                                                                         . $reference_field
-                                                                         . '][content]['
-                                                                         . $extra_field . ']';
-                            $css_class                                 = isset($extra_array['css_class'])
-                                ? $extra_array['css_class']
-                                : '';
-
-                            $template_form_fields[ $field_id ]['css_class'] = ! empty($v_fields)
-                                                                              && in_array($extra_field, $v_fields, true)
-                                                                              && (
-                                                                                  is_array($validators[ $extra_field ])
-                                                                                  && isset($validators[ $extra_field ]['msg'])
-                                                                              )
-                                ? 'validate-error ' . $css_class
-                                : $css_class;
-
-                            $template_form_fields[ $field_id ]['value'] = ! empty($message_templates)
-                                                                          && isset($content[ $extra_field ])
-                                ? $content[ $extra_field ]
-                                : '';
-
-                            // do we have a validation error?  if we do then let's use that value instead
-                            $template_form_fields[ $field_id ]['value'] = isset($validators[ $extra_field ])
-                                ? $validators[ $extra_field ]['value']
-                                : $template_form_fields[ $field_id ]['value'];
-
-
-                            $template_form_fields[ $field_id ]['db-col'] = 'MTP_content';
-
-                            // shortcode selector
-                            $field_name_to_use                                   = $extra_field === 'main'
-                                ? 'content'
-                                : $extra_field;
-                            $template_form_fields[ $field_id ]['append_content'] = $this->_get_shortcode_selector(
-                                $field_name_to_use,
-                                $field_id
-                            );
-                        }
-                        $template_field_MTP_id           = $reference_field . '-MTP_ID';
-                        $template_field_template_name_id = $reference_field . '-name';
-
-                        $template_form_fields[ $template_field_MTP_id ] = [
-                            'name'       => 'MTP_template_fields[' . $reference_field . '][MTP_ID]',
-                            'label'      => null,
-                            'input'      => 'hidden',
-                            'type'       => 'int',
-                            'required'   => false,
-                            'validation' => false,
-                            'value'      => ! empty($message_templates) ? $message_template->ID() : '',
-                            'css_class'  => '',
-                            'format'     => '%d',
-                            'db-col'     => 'MTP_ID',
-                        ];
-
-                        $template_form_fields[ $template_field_template_name_id ] = [
-                            'name'       => 'MTP_template_fields[' . $reference_field . '][name]',
-                            'label'      => null,
-                            'input'      => 'hidden',
-                            'type'       => 'string',
-                            'required'   => false,
-                            'validation' => true,
-                            'value'      => $reference_field,
-                            'css_class'  => '',
-                            'format'     => '%s',
-                            'db-col'     => 'MTP_template_field',
-                        ];
-                    }
-                    continue; // skip the next stuff, we got the necessary fields here for this dataset.
-                } else {
-                    $field_id                                   = $template_field . '-content';
-                    $template_form_fields[ $field_id ]          = $field_setup_array;
-                    $template_form_fields[ $field_id ]['name']  =
-                        'MTP_template_fields[' . $template_field . '][content]';
-                    $message_template                           =
-                        isset($message_templates[ $context ][ $template_field ])
-                            ? $message_templates[ $context ][ $template_field ]
-                            : null;
-                    $template_form_fields[ $field_id ]['value'] = ! empty($message_templates)
-                                                                  && is_array($message_templates[ $context ])
-                                                                  && $message_template instanceof EE_Message_Template
-                        ? $message_template->get('MTP_content')
-                        : '';
-
-                    // do we have a validator error for this field?  if we do then we'll use that value instead
-                    $template_form_fields[ $field_id ]['value'] = isset($validators[ $template_field ])
-                        ? $validators[ $template_field ]['value']
-                        : $template_form_fields[ $field_id ]['value'];
-
-
-                    $template_form_fields[ $field_id ]['db-col']    = 'MTP_content';
-                    $css_class                                      = isset($field_setup_array['css_class'])
-                        ? $field_setup_array['css_class']
-                        : '';
-                    $template_form_fields[ $field_id ]['css_class'] = ! empty($v_fields)
-                                                                      && in_array($template_field, $v_fields, true)
-                                                                      && isset($validators[ $template_field ]['msg'])
-                        ? 'validate-error ' . $css_class
-                        : $css_class;
-
-                    // shortcode selector
-                    $template_form_fields[ $field_id ]['append_content'] = $this->_get_shortcode_selector(
-                        $template_field,
-                        $field_id
-                    );
-                }
-
-                // k took care of content field(s) now let's take care of others.
-
-                $template_field_MTP_id                 = $template_field . '-MTP_ID';
-                $template_field_field_template_name_id = $template_field . '-name';
-
-                // foreach template field there are actually two form fields created
-                $template_form_fields[ $template_field_MTP_id ] = [
-                    'name'       => 'MTP_template_fields[' . $template_field . '][MTP_ID]',
-                    'label'      => null,
-                    'input'      => 'hidden',
-                    'type'       => 'int',
-                    'required'   => false,
-                    'validation' => true,
-                    'value'      => $message_template instanceof EE_Message_Template ? $message_template->ID() : '',
-                    'css_class'  => '',
-                    'format'     => '%d',
-                    'db-col'     => 'MTP_ID',
-                ];
-
-                $template_form_fields[ $template_field_field_template_name_id ] = [
-                    'name'       => 'MTP_template_fields[' . $template_field . '][name]',
-                    'label'      => null,
-                    'input'      => 'hidden',
-                    'type'       => 'string',
-                    'required'   => false,
-                    'validation' => true,
-                    'value'      => $template_field,
-                    'css_class'  => '',
-                    'format'     => '%s',
-                    'db-col'     => 'MTP_template_field',
-                ];
-            }
-
-            // add other fields
-            $template_form_fields['ee-msg-current-context'] = [
-                'name'       => 'MTP_context',
-                'label'      => null,
-                'input'      => 'hidden',
-                'type'       => 'string',
-                'required'   => false,
-                'validation' => true,
-                'value'      => $context,
-                'css_class'  => '',
-                'format'     => '%s',
-                'db-col'     => 'MTP_context',
-            ];
-
-            $template_form_fields['ee-msg-grp-id'] = [
-                'name'       => 'GRP_ID',
-                'label'      => null,
-                'input'      => 'hidden',
-                'type'       => 'int',
-                'required'   => false,
-                'validation' => true,
-                'value'      => $GRP_ID,
-                'css_class'  => '',
-                'format'     => '%d',
-                'db-col'     => 'GRP_ID',
-            ];
-
-            $template_form_fields['ee-msg-messenger'] = [
-                'name'       => 'MTP_messenger',
-                'label'      => null,
-                'input'      => 'hidden',
-                'type'       => 'string',
-                'required'   => false,
-                'validation' => true,
-                'value'      => $message_template_group->messenger(),
-                'css_class'  => '',
-                'format'     => '%s',
-                'db-col'     => 'MTP_messenger',
-            ];
-
-            $template_form_fields['ee-msg-message-type'] = [
-                'name'       => 'MTP_message_type',
-                'label'      => null,
-                'input'      => 'hidden',
-                'type'       => 'string',
-                'required'   => false,
-                'validation' => true,
-                'value'      => $message_template_group->message_type(),
-                'css_class'  => '',
-                'format'     => '%s',
-                'db-col'     => 'MTP_message_type',
-            ];
-
-            $sidebar_form_fields['ee-msg-is-global'] = [
-                'name'       => 'MTP_is_global',
-                'label'      => esc_html__('Global Template', 'event_espresso'),
-                'input'      => 'hidden',
-                'type'       => 'int',
-                'required'   => false,
-                'validation' => true,
-                'value'      => $message_template_group->get('MTP_is_global'),
-                'css_class'  => '',
-                'format'     => '%d',
-                'db-col'     => 'MTP_is_global',
-            ];
-
-            $sidebar_form_fields['ee-msg-is-override'] = [
-                'name'       => 'MTP_is_override',
-                'label'      => esc_html__('Override all custom', 'event_espresso'),
-                'input'      => $message_template_group->is_global() ? 'checkbox' : 'hidden',
-                'type'       => 'int',
-                'required'   => false,
-                'validation' => true,
-                'value'      => $message_template_group->get('MTP_is_override'),
-                'css_class'  => '',
-                'format'     => '%d',
-                'db-col'     => 'MTP_is_override',
-            ];
-
-            $sidebar_form_fields['ee-msg-is-active'] = [
-                'name'       => 'MTP_is_active',
-                'label'      => esc_html__('Active Template', 'event_espresso'),
-                'input'      => 'hidden',
-                'type'       => 'int',
-                'required'   => false,
-                'validation' => true,
-                'value'      => $message_template_group->is_active(),
-                'css_class'  => '',
-                'format'     => '%d',
-                'db-col'     => 'MTP_is_active',
-            ];
-
-            $sidebar_form_fields['ee-msg-deleted'] = [
-                'name'       => 'MTP_deleted',
-                'label'      => null,
-                'input'      => 'hidden',
-                'type'       => 'int',
-                'required'   => false,
-                'validation' => true,
-                'value'      => $message_template_group->get('MTP_deleted'),
-                'css_class'  => '',
-                'format'     => '%d',
-                'db-col'     => 'MTP_deleted',
-            ];
-            $sidebar_form_fields['ee-msg-author']  = [
-                'name'       => 'MTP_user_id',
-                'label'      => esc_html__('Author', 'event_espresso'),
-                'input'      => 'hidden',
-                'type'       => 'int',
-                'required'   => false,
-                'validation' => false,
-                'value'      => $message_template_group->user(),
-                'format'     => '%d',
-                'db-col'     => 'MTP_user_id',
-            ];
-
-            $sidebar_form_fields['ee-msg-route'] = [
-                'name'  => 'action',
-                'input' => 'hidden',
-                'type'  => 'string',
-                'value' => $action,
-            ];
-
-            $sidebar_form_fields['ee-msg-id']        = [
-                'name'  => 'id',
-                'input' => 'hidden',
-                'type'  => 'int',
-                'value' => $GRP_ID,
-            ];
-            $sidebar_form_fields['ee-msg-evt-nonce'] = [
-                'name'  => $action . '_nonce',
-                'input' => 'hidden',
-                'type'  => 'string',
-                'value' => wp_create_nonce($action . '_nonce'),
-            ];
-
-            $template_switch = $this->request->getRequestParam('template_switch');
-            if ($template_switch) {
-                $sidebar_form_fields['ee-msg-template-switch'] = [
-                    'name'  => 'template_switch',
-                    'input' => 'hidden',
-                    'type'  => 'int',
-                    'value' => 1,
-                ];
-            }
-
-
-            $template_fields = $this->_generate_admin_form_fields($template_form_fields);
-            $sidebar_fields  = $this->_generate_admin_form_fields($sidebar_form_fields);
-        } //end if ( !empty($template_field_structure) )
-
-        // set extra content for publish box
-        $this->_template_args['publish_box_extra_content'] = $sidebar_fields;
-        $this->_set_publish_post_box_vars(
-            'id',
-            $GRP_ID,
-            false,
-            add_query_arg(
-                ['action' => 'global_mtps'],
-                $this->_admin_base_url
-            )
-        );
-
-        // add preview button
-        $preview_url    = parent::add_query_args_and_nonce(
-            [
-                'message_type' => $message_template_group->message_type(),
-                'messenger'    => $message_template_group->messenger(),
-                'context'      => $context,
-                'GRP_ID'       => $GRP_ID,
-                'evt_id'       => $EVT_ID ?: false,
-                'action'       => 'preview_message',
-            ],
-            $this->_admin_base_url
-        );
-        $preview_button = '<a href="' . $preview_url . '" class="button--secondary messages-preview-button">'
-                          . esc_html__('Preview', 'event_espresso')
-                          . '</a>';
-
-
-        // setup context switcher
-        $this->_set_context_switcher(
-            $message_template_group,
-            [
-                'page'    => 'espresso_messages',
-                'action'  => 'edit_message_template',
-                'id'      => $GRP_ID,
-                'evt_id'  => $EVT_ID,
-                'context' => $context,
-                'extra'   => $preview_button,
-            ]
-        );
-
-
-        // main box
-        $this->_template_args['template_fields']                         = $template_fields;
-        $this->_template_args['sidebar_box_id']                          = 'details';
-        $this->_template_args['action']                                  = $action;
-        $this->_template_args['context']                                 = $context;
-        $this->_template_args['edit_message_template_form_url']          = $edit_message_template_form_url;
-        $this->_template_args['learn_more_about_message_templates_link'] =
-            $this->_learn_more_about_message_templates_link();
-
-
-        $this->_template_args['before_admin_page_content'] = '<div class="ee-msg-admin-header">';
-        $this->_template_args['before_admin_page_content'] .= $this->add_active_context_element(
-            $message_template_group,
-            $context,
-            $context_label
-        );
-        $this->_template_args['before_admin_page_content'] .= $this->add_context_switcher();
-        $this->_template_args['before_admin_page_content'] .= '</div>';
-        $this->_template_args['before_admin_page_content'] .= $this->_add_form_element_before();
-        $this->_template_args['after_admin_page_content']  = $this->_add_form_element_after();
-
-        $this->_template_path = $this->_template_args['GRP_ID']
-            ? EE_MSG_TEMPLATE_PATH . 'ee_msg_details_main_edit_meta_box.template.php'
-            : EE_MSG_TEMPLATE_PATH . 'ee_msg_details_main_add_meta_box.template.php';
-
-        // send along EE_Message_Template_Group object for further template use.
-        $this->_template_args['MTP'] = $message_template_group;
-
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            $this->_template_path,
-            $this->_template_args,
-            true
-        );
-
-
-        // finally, let's set the admin_page title
-        $this->_admin_page_title = sprintf(esc_html__('Editing %s', 'event_espresso'), $title);
-
-
-        // we need to take care of setting the shortcodes property for use elsewhere.
-        $this->_set_shortcodes();
-
-
-        // final template wrapper
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    public function filter_tinymce_init($mceInit, $editor_id)
-    {
-        return $mceInit;
-    }
-
-
-    public function add_context_switcher()
-    {
-        return $this->_context_switcher;
-    }
-
-
-    /**
-     * Adds the activation/deactivation toggle for the message template context.
-     *
-     * @param EE_Message_Template_Group $message_template_group
-     * @param string                    $context
-     * @param string                    $context_label
-     * @return string
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidIdentifierException
-     * @throws ReflectionException
-     */
-    protected function add_active_context_element(
-        EE_Message_Template_Group $message_template_group,
-        $context,
-        $context_label
-    ) {
-        $template_args = [
-            'context'                   => $context,
-            'nonce'                     => wp_create_nonce('activate_' . $context . '_toggle_nonce'),
-            'is_active'                 => $message_template_group->is_context_active($context),
-            'on_off_action'             => $message_template_group->is_context_active($context)
-                ? 'context-off'
-                : 'context-on',
-            'context_label'             => str_replace(['(', ')'], '', $context_label),
-            'message_template_group_id' => $message_template_group->ID(),
-        ];
-        return EEH_Template::display_template(
-            EE_MSG_TEMPLATE_PATH . 'ee_msg_editor_active_context_element.template.php',
-            $template_args,
-            true
-        );
-    }
-
-
-    /**
-     * Ajax callback for `toggle_context_template` ajax action.
-     * Handles toggling the message context on or off.
-     *
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidIdentifierException
-     * @throws InvalidInterfaceException
-     */
-    public function toggle_context_template()
-    {
-        $success = true;
-        // check for required data
-        if (
-            ! (
-                $this->request->requestParamIsSet('message_template_group_id')
-                && $this->request->requestParamIsSet('context')
-                && $this->request->requestParamIsSet('status')
-            )
-        ) {
-            EE_Error::add_error(
-                esc_html__('Required data for doing this action is not available.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $success = false;
-        }
-
-        $nonce   = $this->request->getRequestParam('toggle_context_nonce', '');
-        $context = $this->request->getRequestParam('context', '');
-        $status  = $this->request->getRequestParam('status', '');
-
-        $this->_verify_nonce($nonce, "activate_{$context}_toggle_nonce");
-
-        if ($status !== 'off' && $status !== 'on') {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__('The given status (%s) is not valid. Must be "off" or "on"', 'event_espresso'),
-                    $status
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $success = false;
-        }
-        $message_template_group_id = $this->request->getRequestParam('message_template_group_id', 0, 'int');
-        $message_template_group    = $this->getMtgModel()->get_one_by_ID($message_template_group_id);
-        if (! $message_template_group instanceof EE_Message_Template_Group) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'Unable to change the active state because the given id "%1$d" does not match a valid "%2$s"',
-                        'event_espresso'
-                    ),
-                    $message_template_group_id,
-                    'EE_Message_Template_Group'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $success = false;
-        }
-        if ($success) {
-            $success = $status === 'off'
-                ? $message_template_group->deactivate_context($context)
-                : $message_template_group->activate_context($context);
-        }
-        $this->_template_args['success'] = $success;
-        $this->_return_json();
-    }
-
-
-    public function _add_form_element_before()
-    {
-        return '<form method="post" action="'
-               . $this->_template_args['edit_message_template_form_url']
-               . '" id="ee-msg-edit-frm">';
-    }
-
-
-    public function _add_form_element_after()
-    {
-        return '</form>';
-    }
-
-
-    /**
-     * This executes switching the template pack for a message template.
-     *
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @since 4.5.0
-     */
-    public function switch_template_pack()
-    {
-
-        $GRP_ID        = $this->request->getRequestParam('GRP_ID', 0, 'int');
-        $template_pack = $this->request->getRequestParam('template_pack', '');
-
-        // verify we have needed values.
-        if (empty($GRP_ID) || empty($template_pack)) {
-            $this->_template_args['error'] = true;
-            EE_Error::add_error(
-                esc_html__('The required date for switching templates is not available.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        } else {
-            // get template, set the new template_pack and then reset to default
-            /** @var EE_Message_Template_Group $message_template_group */
-            $message_template_group = $this->getMtgModel()->get_one_by_ID($GRP_ID);
-
-            $message_template_group->set_template_pack_name($template_pack);
-            $this->request->setRequestParam('msgr', $message_template_group->messenger());
-            $this->request->setRequestParam('mt', $message_template_group->message_type());
-
-            $query_args = $this->_reset_to_default_template();
-
-            if (empty($query_args['id'])) {
-                EE_Error::add_error(
-                    esc_html__(
-                        'Something went wrong with switching the template pack. Please try again or contact EE support',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                $this->_template_args['error'] = true;
-            } else {
-                $template_label       = $message_template_group->get_template_pack()->label;
-                $template_pack_labels = $message_template_group->messenger_obj()->get_supports_labels();
-                EE_Error::add_success(
-                    sprintf(
-                        esc_html__(
-                            'This message template has been successfully switched to use the %1$s %2$s.  Please wait while the page reloads with your new template.',
-                            'event_espresso'
-                        ),
-                        $template_label,
-                        $template_pack_labels->template_pack
-                    )
-                );
-                // generate the redirect url for js.
-                $url = self::add_query_args_and_nonce($query_args, $this->_admin_base_url);
-
-                $this->_template_args['data']['redirect_url'] = $url;
-                $this->_template_args['success']              = true;
-            }
-
-            $this->_return_json();
-        }
-    }
-
-
-    /**
-     * This handles resetting the template for the given messenger/message_type so that users can start from scratch if
-     * they want.
-     *
-     * @access protected
-     * @return array|void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _reset_to_default_template()
-    {
-        $templates    = [];
-        $GRP_ID       = $this->request->getRequestParam('GRP_ID', 0, 'int');
-        $messenger    = $this->request->getRequestParam('msgr');
-        $message_type = $this->request->getRequestParam('mt');
-        // we need to make sure we've got the info we need.
-        if (! ($GRP_ID && $messenger && $message_type)) {
-            EE_Error::add_error(
-                esc_html__(
-                    'In order to reset the template to its default we require the messenger, message type, and message template GRP_ID to know what is being reset.  At least one of these is missing.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-
-        // all templates will be reset to whatever the defaults are
-        // for the global template matching the messenger and message type.
-        $success = ! empty($GRP_ID);
-
-        if ($success) {
-            // let's first determine if the incoming template is a global template,
-            // if it isn't then we need to get the global template matching messenger and message type.
-            // $MTPG = $this->getMtgModel()->get_one_by_ID( $GRP_ID );
-
-
-            // note this is ONLY deleting the template fields (Message Template rows) NOT the message template group.
-            $success = $this->_delete_mtp_permanently($GRP_ID, false);
-
-            if ($success) {
-                // if successfully deleted, lets generate the new ones.
-                // Note. We set GLOBAL to true, because resets on ANY template
-                // will use the related global template defaults for regeneration.
-                // This means that if a custom template is reset it resets to whatever the related global template is.
-                // HOWEVER, we DO keep the template pack and template variation set
-                // for the current custom template when resetting.
-                $templates = $this->_generate_new_templates($messenger, $message_type, $GRP_ID, true);
-            }
-        }
-
-        // any error messages?
-        if (! $success) {
-            EE_Error::add_error(
-                esc_html__(
-                    'Something went wrong with deleting existing templates. Unable to reset to default',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-
-        // all good, let's add a success message!
-        if ($success && ! empty($templates)) {
-            // the info for the template we generated is the first element in the returned array
-            EE_Error::overwrite_success();
-            EE_Error::add_success(esc_html__('Templates have been reset to defaults.', 'event_espresso'));
-        }
-
-
-        $query_args = [
-            'id'      => isset($templates['GRP_ID']) ? $templates['GRP_ID'] : null,
-            'context' => isset($templates['MTP_context']) ? $templates['MTP_context'] : null,
-            'action'  => isset($templates['GRP_ID']) ? 'edit_message_template' : 'global_mtps',
-        ];
-
-        // if called via ajax then we return query args otherwise redirect
-        if ($this->request->isAjax()) {
-            return $query_args;
-        }
-        $this->_redirect_after_action(false, '', '', $query_args, true);
-    }
-
-
-    /**
-     * Retrieve and set the message preview for display.
-     *
-     * @param bool $send if TRUE then we are doing an actual TEST send with the results of the preview.
-     * @return string
-     * @throws ReflectionException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function _preview_message($send = false)
-    {
-        // first make sure we've got the necessary parameters
-        $GRP_ID = $this->request->getRequestParam('GRP_ID', 0, 'int');
-        if (! ($GRP_ID && $this->_active_messenger_name && $this->_active_message_type_name)) {
-            EE_Error::add_error(
-                esc_html__('Missing necessary parameters for displaying preview', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-
-        $context = $this->request->getRequestParam('context');
-        // get the preview!
-        $preview = EED_Messages::preview_message(
-            $this->_active_message_type_name,
-            $context,
-            $this->_active_messenger_name,
-            $send
-        );
-
-        if ($send) {
-            return $preview;
-        }
-
-        // if we have an evt_id set on the request, use it.
-        $EVT_ID = $this->request->getRequestParam('evt_id', 0, 'int');
-
-        // let's add a button to go back to the edit view
-        $query_args             = [
-            'id'      => $GRP_ID,
-            'evt_id'  => $EVT_ID,
-            'context' => $context,
-            'action'  => 'edit_message_template',
-        ];
-        $go_back_url            = parent::add_query_args_and_nonce($query_args, $this->_admin_base_url);
-        $preview_button         = '<a href="'
-                                  . $go_back_url
-                                  . '" class="button--secondary messages-preview-go-back-button">'
-                                  . esc_html__('Go Back to Edit', 'event_espresso')
-                                  . '</a>';
-        $message_types          = $this->get_installed_message_types();
-        $active_messenger       = $this->_message_resource_manager->get_active_messenger($this->_active_messenger_name);
-        $active_messenger_label = $active_messenger instanceof EE_messenger
-            ? ucwords($active_messenger->label['singular'])
-            : esc_html__('Unknown Messenger', 'event_espresso');
-        // let's provide a helpful title for context
-        $preview_title = sprintf(
-            esc_html__('Viewing Preview for %s %s Message Template', 'event_espresso'),
-            $active_messenger_label,
-            ucwords($message_types[ $this->_active_message_type_name ]->label['singular'])
-        );
-        if (empty($preview)) {
-            $this->noEventsErrorMessage();
-        }
-        // setup display of preview.
-        $this->_admin_page_title                    = $preview_title;
-        $this->_template_args['admin_page_title']   = $preview_title;
-        $this->_template_args['admin_page_content'] = $preview_button . '<br />' . $preview;
-        $this->_template_args['data']['force_json'] = true;
-
-        return '';
-    }
-
-
-    /**
-     * Used to set an error if there are no events available for generating a preview/test send.
-     *
-     * @param bool $test_send Whether the error should be generated for the context of a test send.
-     */
-    protected function noEventsErrorMessage($test_send = false)
-    {
-        $events_url = parent::add_query_args_and_nonce(
-            [
-                'action' => 'default',
-                'page'   => 'espresso_events',
-            ],
-            admin_url('admin.php')
-        );
-        $message    = $test_send
-            ? esc_html__(
-                'A test message could not be sent for this message template because there are no events created yet. The preview system uses actual events for generating the test message. %1$sGo see your events%2$s!',
-                'event_espresso'
-            )
-            : esc_html__(
-                'There is no preview for this message template available because there are no events created yet. The preview system uses actual events for generating the preview. %1$sGo see your events%2$s!',
-                'event_espresso'
-            );
-
-        EE_Error::add_attention(
-            sprintf(
-                $message,
-                "<a href='{$events_url}'>",
-                '</a>'
-            )
-        );
-    }
-
-
-    /**
-     * The initial _preview_message is on a no headers route.  It will optionally call this if necessary otherwise it
-     * gets called automatically.
-     *
-     * @return void
-     * @throws EE_Error
-     * @since 4.5.0
-     *
-     */
-    protected function _display_preview_message()
-    {
-        $this->display_admin_page_with_no_sidebar();
-    }
-
-
-    /**
-     * registers metaboxes that should show up on the "edit_message_template" page
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _register_edit_meta_boxes()
-    {
-        $this->addMetaBox(
-            'mtp_valid_shortcodes',
-            esc_html__('Valid Shortcodes', 'event_espresso'),
-            [$this, 'shortcode_meta_box'],
-            $this->_current_screen->id,
-            'side'
-        );
-        $this->addMetaBox(
-            'mtp_extra_actions',
-            esc_html__('Extra Actions', 'event_espresso'),
-            [$this, 'extra_actions_meta_box'],
-            $this->_current_screen->id,
-            'side',
-            'high'
-        );
-        $this->addMetaBox(
-            'mtp_templates',
-            esc_html__('Template Styles', 'event_espresso'),
-            [$this, 'template_pack_meta_box'],
-            $this->_current_screen->id,
-            'side',
-            'high'
-        );
-    }
-
-
-    /**
-     * metabox content for all template pack and variation selection.
-     *
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @since 4.5.0
-     */
-    public function template_pack_meta_box()
-    {
-        $this->_set_message_template_group();
-
-        $tp_collection = EEH_MSG_Template::get_template_pack_collection();
-
-        $tp_select_values = [];
-
-        foreach ($tp_collection as $tp) {
-            // only include template packs that support this messenger and message type!
-            $supports = $tp->get_supports();
-            if (
-                ! isset($supports[ $this->_message_template_group->messenger() ])
-                || ! in_array(
-                    $this->_message_template_group->message_type(),
-                    $supports[ $this->_message_template_group->messenger() ],
-                    true
-                )
-            ) {
-                // not supported
-                continue;
-            }
-
-            $tp_select_values[] = [
-                'text' => $tp->label,
-                'id'   => $tp->dbref,
-            ];
-        }
-
-        // if empty $tp_select_values then we make sure default is set because EVERY message type should be supported by
-        // the default template pack.  This still allows for the odd template pack to override.
-        if (empty($tp_select_values)) {
-            $tp_select_values[] = [
-                'text' => esc_html__('Default', 'event_espresso'),
-                'id'   => 'default',
-            ];
-        }
-
-        // setup variation select values for the currently selected template.
-        $variations               = $this->_message_template_group->get_template_pack()->get_variations(
-            $this->_message_template_group->messenger(),
-            $this->_message_template_group->message_type()
-        );
-        $variations_select_values = [];
-        foreach ($variations as $variation => $label) {
-            $variations_select_values[] = [
-                'text' => $label,
-                'id'   => $variation,
-            ];
-        }
-
-        $template_pack_labels = $this->_message_template_group->messenger_obj()->get_supports_labels();
-
-        $template_args['template_packs_selector']        = EEH_Form_Fields::select_input(
-            'MTP_template_pack',
-            $tp_select_values,
-            $this->_message_template_group->get_template_pack_name()
-        );
-        $template_args['variations_selector']            = EEH_Form_Fields::select_input(
-            'MTP_template_variation',
-            $variations_select_values,
-            $this->_message_template_group->get_template_pack_variation()
-        );
-        $template_args['template_pack_label']            = $template_pack_labels->template_pack;
-        $template_args['template_variation_label']       = $template_pack_labels->template_variation;
-        $template_args['template_pack_description']      = $template_pack_labels->template_pack_description;
-        $template_args['template_variation_description'] = $template_pack_labels->template_variation_description;
-
-        $template = EE_MSG_TEMPLATE_PATH . 'template_pack_and_variations_metabox.template.php';
-
-        EEH_Template::display_template($template, $template_args);
-    }
-
-
-    /**
-     * This meta box holds any extra actions related to Message Templates
-     * For now, this includes Resetting templates to defaults and sending a test email.
-     *
-     * @access  public
-     * @return void
-     * @throws EE_Error
-     */
-    public function extra_actions_meta_box()
-    {
-        $template_form_fields = [];
-
-        $extra_args = [
-            'msgr'   => $this->_message_template_group->messenger(),
-            'mt'     => $this->_message_template_group->message_type(),
-            'GRP_ID' => $this->_message_template_group->GRP_ID(),
-        ];
-        // first we need to see if there are any fields
-        $fields = $this->_message_template_group->messenger_obj()->get_test_settings_fields();
-
-        if (! empty($fields)) {
-            // yup there be fields
-            foreach ($fields as $field => $config) {
-                $field_id = $this->_message_template_group->messenger() . '_' . $field;
-                $existing = $this->_message_template_group->messenger_obj()->get_existing_test_settings();
-                $default  = isset($config['default']) ? $config['default'] : '';
-                $default  = isset($config['value']) ? $config['value'] : $default;
-
-                // if type is hidden and the value is empty
-                // something may have gone wrong so let's correct with the defaults
-                $fix                = $config['input'] === 'hidden'
-                                      && isset($existing[ $field ])
-                                      && empty($existing[ $field ])
-                    ? $default
-                    : '';
-                $existing[ $field ] = isset($existing[ $field ]) && empty($fix)
-                    ? $existing[ $field ]
-                    : $fix;
-
-                $template_form_fields[ $field_id ] = [
-                    'name'       => 'test_settings_fld[' . $field . ']',
-                    'label'      => $config['label'],
-                    'input'      => $config['input'],
-                    'type'       => $config['type'],
-                    'required'   => $config['required'],
-                    'validation' => $config['validation'],
-                    'value'      => isset($existing[ $field ]) ? $existing[ $field ] : $default,
-                    'css_class'  => $config['css_class'],
-                    'options'    => isset($config['options']) ? $config['options'] : [],
-                    'default'    => $default,
-                    'format'     => $config['format'],
-                ];
-            }
-        }
-
-        $test_settings_html = ! empty($template_form_fields)
-            ? $this->_generate_admin_form_fields($template_form_fields, 'string', 'ee_tst_settings_flds')
-            : '';
-
-        // print out $test_settings_fields
-        if (! empty($test_settings_html)) {
-            $test_settings_html .= '<input type="submit" class="button--primary mtp-test-button alignright" ';
-            $test_settings_html .= 'name="test_button" value="';
-            $test_settings_html .= esc_html__('Test Send', 'event_espresso');
-            $test_settings_html .= '" /><div style="clear:both"></div>';
-        }
-
-        // and button
-        $test_settings_html .= '<div class="publishing-action alignright resetbutton">';
-        $test_settings_html .= '<p>';
-        $test_settings_html .= esc_html__('Need to reset this message type and start over?', 'event_espresso');
-        $test_settings_html .= '</p>';
-        $test_settings_html .= $this->get_action_link_or_button(
-            'reset_to_default',
-            'reset',
-            $extra_args,
-            'button--primary reset-default-button'
-        );
-        $test_settings_html .= '</div><div style="clear:both"></div>';
-        echo wp_kses($test_settings_html, AllowedTags::getWithFormTags());
-    }
-
-
-    /**
-     * This returns the shortcode selector skeleton for a given context and field.
-     *
-     * @param string $field           The name of the field retrieving shortcodes for.
-     * @param string $linked_input_id The css id of the input that the shortcodes get added to.
-     * @return string
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @since 4.9.rc.000
-     */
-    protected function _get_shortcode_selector($field, $linked_input_id)
-    {
-        $template_args = [
-            'shortcodes'      => $this->_get_shortcodes([$field]),
-            'fieldname'       => $field,
-            'linked_input_id' => $linked_input_id,
-        ];
-
-        return EEH_Template::display_template(
-            EE_MSG_TEMPLATE_PATH . 'shortcode_selector_skeleton.template.php',
-            $template_args,
-            true
-        );
-    }
-
-
-    /**
-     * This just takes care of returning the meta box content for shortcodes (only used on the edit message template
-     * page)
-     *
-     * @access public
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function shortcode_meta_box()
-    {
-        $shortcodes = $this->_get_shortcodes([], false);
-        // just make sure the shortcodes property is set
-        // $messenger = $this->_message_template_group->messenger_obj();
-        // now let's set the content depending on the status of the shortcodes array
-        if (empty($shortcodes)) {
-            echo '<p>' . esc_html__('There are no valid shortcodes available', 'event_espresso') . '</p>';
-            return;
-        }
-        ?>
+	/**
+	 * @var EEM_Message
+	 */
+	private $MSG_MODEL;
+
+	/**
+	 * @var EEM_Message_Template
+	 */
+	private $MTP_MODEL;
+
+	/**
+	 * @var EEM_Message_Template_Group
+	 */
+	private $MTG_MODEL;
+
+	/**
+	 * @var EE_Message_Resource_Manager $_message_resource_manager
+	 */
+	protected $_message_resource_manager;
+
+	/**
+	 * @var string
+	 */
+	protected $_active_message_type_name = '';
+
+	/**
+	 * @var string
+	 */
+	protected $_active_messenger_name = '';
+
+	/**
+	 * @var EE_messenger $_active_messenger
+	 */
+	protected $_active_messenger;
+
+	protected $_activate_meta_box_type;
+
+	protected $_current_message_meta_box;
+
+	protected $_current_message_meta_box_object;
+
+	protected $_context_switcher;
+
+	protected $_shortcodes           = [];
+
+	protected $_active_messengers    = [];
+
+	protected $_active_message_types = [];
+
+	/**
+	 * @var EE_Message_Template_Group $_message_template_group
+	 */
+	protected $_message_template_group;
+
+	protected $_m_mt_settings = [];
+
+
+	/**
+	 * This is set via the _set_message_template_group method and holds whatever the template pack for the group is.
+	 * IF there is no group then it gets automatically set to the Default template pack.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @var EE_Messages_Template_Pack
+	 */
+	protected $_template_pack;
+
+
+	/**
+	 * This is set via the _set_message_template_group method and holds whatever the template pack variation for the
+	 * group is.  If there is no group then it automatically gets set to default.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @var string
+	 */
+	protected $_variation;
+
+
+	/**
+	 * @param bool $routing
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function __construct($routing = true)
+	{
+		// make sure messages autoloader is running
+		EED_Messages::set_autoloaders();
+		parent::__construct($routing);
+	}
+
+
+	/**
+	 * @return EEM_Message
+	 * @throws EE_Error
+	 */
+	public function getMsgModel()
+	{
+		if (! $this->MSG_MODEL instanceof EEM_Message) {
+			$this->MSG_MODEL = EEM_Message::instance();
+		}
+		return $this->MSG_MODEL;
+	}
+
+
+	/**
+	 * @return EEM_Message_Template
+	 * @throws EE_Error
+	 */
+	public function getMtpModel()
+	{
+		if (! $this->MTP_MODEL instanceof EEM_Message_Template) {
+			$this->MTP_MODEL = EEM_Message_Template::instance();
+		}
+		return $this->MTP_MODEL;
+	}
+
+
+	/**
+	 * @return EEM_Message_Template_Group
+	 * @throws EE_Error
+	 */
+	public function getMtgModel()
+	{
+		if (! $this->MTG_MODEL instanceof EEM_Message_Template_Group) {
+			$this->MTG_MODEL = EEM_Message_Template_Group::instance();
+		}
+		return $this->MTG_MODEL;
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _init_page_props()
+	{
+		$this->page_slug        = EE_MSG_PG_SLUG;
+		$this->page_label       = esc_html__('Messages Settings', 'event_espresso');
+		$this->_admin_base_url  = EE_MSG_ADMIN_URL;
+		$this->_admin_base_path = EE_MSG_ADMIN;
+
+		$messenger    = $this->request->getRequestParam('messenger', '');
+		$message_type = $this->request->getRequestParam('message_type', '');
+		$this->_active_messenger_name    = $this->request->getRequestParam('MTP_messenger', $messenger);
+		$this->_active_message_type_name = $this->request->getRequestParam('MTP_message_type', $message_type);
+
+		$this->_load_message_resource_manager();
+	}
+
+
+	/**
+	 * loads messenger objects into the $_active_messengers property (so we can access the needed methods)
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	protected function _load_message_resource_manager()
+	{
+		$this->_message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+	}
+
+
+	/**
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @deprecated 4.9.9.rc.014
+	 */
+	public function get_messengers_for_list_table()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__(
+					'This method is no longer in use.  There is no replacement for it. The method was used to generate a set of values for use in creating a messenger filter dropdown which is now generated differently via %s',
+					'event_espresso'
+				),
+				'Messages_Admin_Page::get_messengers_select_input()'
+			),
+			'4.9.9.rc.014'
+		);
+
+		$m_values          = [];
+		$active_messengers = $this->getMsgModel()->get_all(['group_by' => 'MSG_messenger']);
+		// setup messengers for selects
+		$i = 1;
+		foreach ($active_messengers as $active_messenger) {
+			if ($active_messenger instanceof EE_Message) {
+				$m_values[ $i ]['id']   = $active_messenger->messenger();
+				$m_values[ $i ]['text'] = ucwords($active_messenger->messenger_label());
+				$i++;
+			}
+		}
+
+		return $m_values;
+	}
+
+
+	/**
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @deprecated 4.9.9.rc.014
+	 */
+	public function get_message_types_for_list_table()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__(
+					'This method is no longer in use.  There is no replacement for it. The method was used to generate a set of values for use in creating a message type filter dropdown which is now generated differently via %s',
+					'event_espresso'
+				),
+				'Messages_Admin_Page::get_message_types_select_input()'
+			),
+			'4.9.9.rc.014'
+		);
+
+		$mt_values       = [];
+		$active_messages = $this->getMsgModel()->get_all(['group_by' => 'MSG_message_type']);
+		$i               = 1;
+		foreach ($active_messages as $active_message) {
+			if ($active_message instanceof EE_Message) {
+				$mt_values[ $i ]['id']   = $active_message->message_type();
+				$mt_values[ $i ]['text'] = ucwords($active_message->message_type_label());
+				$i++;
+			}
+		}
+
+		return $mt_values;
+	}
+
+
+	/**
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @deprecated 4.9.9.rc.014
+	 */
+	public function get_contexts_for_message_types_for_list_table()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__(
+					'This method is no longer in use.  There is no replacement for it. The method was used to generate a set of values for use in creating a message type context filter dropdown which is now generated differently via %s',
+					'event_espresso'
+				),
+				'Messages_Admin_Page::get_contexts_for_message_types_select_input()'
+			),
+			'4.9.9.rc.014'
+		);
+
+		$contexts                = [];
+		$active_message_contexts = $this->getMsgModel()->get_all(['group_by' => 'MSG_context']);
+		foreach ($active_message_contexts as $active_message) {
+			if ($active_message instanceof EE_Message) {
+				$message_type = $active_message->message_type_object();
+				if ($message_type instanceof EE_message_type) {
+					$message_type_contexts = $message_type->get_contexts();
+					foreach ($message_type_contexts as $context => $context_details) {
+						$contexts[ $context ] = $context_details['label'];
+					}
+				}
+			}
+		}
+
+		return $contexts;
+	}
+
+
+	/**
+	 * Generate select input with provided messenger options array.
+	 *
+	 * @param array $messenger_options Array of messengers indexed by messenger slug and values are the messenger
+	 *                                 labels.
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_messengers_select_input($messenger_options)
+	{
+		// if empty or just one value then just return an empty string
+		if (
+			empty($messenger_options)
+			|| ! is_array($messenger_options)
+			|| count($messenger_options) === 1
+		) {
+			return '';
+		}
+		// merge in default
+		$messenger_options = array_merge(
+			['none_selected' => esc_html__('Show All Messengers', 'event_espresso')],
+			$messenger_options
+		);
+		$input             = new EE_Select_Input(
+			$messenger_options,
+			[
+				'html_name'  => 'ee_messenger_filter_by',
+				'html_id'    => 'ee_messenger_filter_by',
+				'html_class' => 'wide',
+				'default'    => $this->request->getRequestParam('ee_messenger_filter_by', 'none_selected', 'title'),
+			]
+		);
+
+		return $input->get_html_for_input();
+	}
+
+
+	/**
+	 * Generate select input with provided message type options array.
+	 *
+	 * @param array $message_type_options Array of message types indexed by message type slug, and values are the
+	 *                                    message type labels
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_message_types_select_input($message_type_options)
+	{
+		// if empty or count of options is 1 then just return an empty string
+		if (
+			empty($message_type_options)
+			|| ! is_array($message_type_options)
+			|| count($message_type_options) === 1
+		) {
+			return '';
+		}
+		// merge in default
+		$message_type_options = array_merge(
+			['none_selected' => esc_html__('Show All Message Types', 'event_espresso')],
+			$message_type_options
+		);
+		$input                = new EE_Select_Input(
+			$message_type_options,
+			[
+				'html_name'  => 'ee_message_type_filter_by',
+				'html_id'    => 'ee_message_type_filter_by',
+				'html_class' => 'wide',
+				'default'    => $this->request->getRequestParam('ee_message_type_filter_by', 'none_selected', 'title'),
+			]
+		);
+
+		return $input->get_html_for_input();
+	}
+
+
+	/**
+	 * Generate select input with provide message type contexts array.
+	 *
+	 * @param array $context_options Array of message type contexts indexed by context slug, and values are the
+	 *                               context label.
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_contexts_for_message_types_select_input($context_options)
+	{
+		// if empty or count of options is one then just return empty string
+		if (
+			empty($context_options)
+			|| ! is_array($context_options)
+			|| count($context_options) === 1
+		) {
+			return '';
+		}
+		// merge in default
+		$context_options = array_merge(
+			['none_selected' => esc_html__('Show all Contexts', 'event_espresso')],
+			$context_options
+		);
+		$input           = new EE_Select_Input(
+			$context_options,
+			[
+				'html_name'  => 'ee_context_filter_by',
+				'html_id'    => 'ee_context_filter_by',
+				'html_class' => 'wide',
+				'default'    => $this->request->getRequestParam('ee_context_filter_by', 'none_selected', 'title'),
+			]
+		);
+
+		return $input->get_html_for_input();
+	}
+
+
+	protected function _ajax_hooks()
+	{
+		add_action('wp_ajax_activate_messenger', [$this, 'activate_messenger_toggle']);
+		add_action('wp_ajax_activate_mt', [$this, 'activate_mt_toggle']);
+		add_action('wp_ajax_ee_msgs_save_settings', [$this, 'save_settings']);
+		add_action('wp_ajax_ee_msgs_update_mt_form', [$this, 'update_mt_form']);
+		add_action('wp_ajax_switch_template_pack', [$this, 'switch_template_pack']);
+		add_action('wp_ajax_toggle_context_template', [$this, 'toggle_context_template']);
+	}
+
+
+	protected function _define_page_props()
+	{
+		$this->_admin_page_title = $this->page_label;
+		$this->_labels           = [
+			'buttons'    => [
+				'add'    => esc_html__('Add New Message Template', 'event_espresso'),
+				'edit'   => esc_html__('Edit Message Template', 'event_espresso'),
+				'delete' => esc_html__('Delete Message Template', 'event_espresso'),
+			],
+			'publishbox' => esc_html__('Update Actions', 'event_espresso'),
+		];
+	}
+
+
+	/**
+	 *        an array for storing key => value pairs of request actions and their corresponding methods
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_page_routes()
+	{
+		$GRP_ID = $this->request->getRequestParam('GRP_ID', 0, 'int');
+		$GRP_ID = $this->request->getRequestParam('id', $GRP_ID, 'int');
+		$MSG_ID = $this->request->getRequestParam('MSG_ID', 0, 'int');
+
+		$this->_page_routes = [
+			'default'                          => [
+				'func'       => '_message_queue_list_table',
+				'capability' => 'ee_read_global_messages',
+			],
+			'global_mtps'                      => [
+				'func'       => '_ee_default_messages_overview_list_table',
+				'capability' => 'ee_read_global_messages',
+			],
+			'custom_mtps'                      => [
+				'func'       => '_custom_mtps_preview',
+				'capability' => 'ee_read_messages',
+			],
+			'add_new_message_template'         => [
+				'func'       => 'add_message_template',
+				'capability' => 'ee_edit_messages',
+				'noheader'   => true,
+			],
+			'edit_message_template'            => [
+				'func'       => '_edit_message_template',
+				'capability' => 'ee_edit_message',
+				'obj_id'     => $GRP_ID,
+			],
+			'preview_message'                  => [
+				'func'               => '_preview_message',
+				'capability'         => 'ee_read_message',
+				'obj_id'             => $GRP_ID,
+				'noheader'           => true,
+				'headers_sent_route' => 'display_preview_message',
+			],
+			'display_preview_message'          => [
+				'func'       => '_display_preview_message',
+				'capability' => 'ee_read_message',
+				'obj_id'     => $GRP_ID,
+			],
+			'insert_message_template'          => [
+				'func'       => '_insert_or_update_message_template',
+				'capability' => 'ee_edit_messages',
+				'args'       => ['new' => true],
+				'noheader'   => true,
+			],
+			'update_message_template'          => [
+				'func'       => '_insert_or_update_message_template',
+				'capability' => 'ee_edit_message',
+				'obj_id'     => $GRP_ID,
+				'args'       => ['new' => false],
+				'noheader'   => true,
+			],
+			'trash_message_template'           => [
+				'func'       => '_trash_or_restore_message_template',
+				'capability' => 'ee_delete_message',
+				'obj_id'     => $GRP_ID,
+				'args'       => ['trash' => true, 'all' => true],
+				'noheader'   => true,
+			],
+			'trash_message_template_context'   => [
+				'func'       => '_trash_or_restore_message_template',
+				'capability' => 'ee_delete_message',
+				'obj_id'     => $GRP_ID,
+				'args'       => ['trash' => true],
+				'noheader'   => true,
+			],
+			'restore_message_template'         => [
+				'func'       => '_trash_or_restore_message_template',
+				'capability' => 'ee_delete_message',
+				'obj_id'     => $GRP_ID,
+				'args'       => ['trash' => false, 'all' => true],
+				'noheader'   => true,
+			],
+			'restore_message_template_context' => [
+				'func'       => '_trash_or_restore_message_template',
+				'capability' => 'ee_delete_message',
+				'obj_id'     => $GRP_ID,
+				'args'       => ['trash' => false],
+				'noheader'   => true,
+			],
+			'delete_message_template'          => [
+				'func'       => '_delete_message_template',
+				'capability' => 'ee_delete_message',
+				'obj_id'     => $GRP_ID,
+				'noheader'   => true,
+			],
+			'reset_to_default'                 => [
+				'func'       => '_reset_to_default_template',
+				'capability' => 'ee_edit_message',
+				'obj_id'     => $GRP_ID,
+				'noheader'   => true,
+			],
+			'settings'                         => [
+				'func'       => '_settings',
+				'capability' => 'manage_options',
+			],
+			'update_global_settings'           => [
+				'func'       => '_update_global_settings',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			],
+			'generate_now'                     => [
+				'func'       => '_generate_now',
+				'capability' => 'ee_send_message',
+				'noheader'   => true,
+			],
+			'generate_and_send_now'            => [
+				'func'       => '_generate_and_send_now',
+				'capability' => 'ee_send_message',
+				'noheader'   => true,
+			],
+			'queue_for_resending'              => [
+				'func'       => '_queue_for_resending',
+				'capability' => 'ee_send_message',
+				'noheader'   => true,
+			],
+			'send_now'                         => [
+				'func'       => '_send_now',
+				'capability' => 'ee_send_message',
+				'noheader'   => true,
+			],
+			'delete_ee_message'                => [
+				'func'       => '_delete_ee_messages',
+				'capability' => 'ee_delete_messages',
+				'noheader'   => true,
+			],
+			'delete_ee_messages'               => [
+				'func'       => '_delete_ee_messages',
+				'capability' => 'ee_delete_messages',
+				'noheader'   => true,
+				'obj_id'     => $MSG_ID,
+			],
+		];
+	}
+
+
+	protected function _set_page_config()
+	{
+		$this->_page_config = [
+			'default'                  => [
+				'nav'           => [
+					'label' => esc_html__('Message Activity', 'event_espresso'),
+					'icon' => 'dashicons-email',
+					'order' => 10,
+				],
+				'list_table'    => 'EE_Message_List_Table',
+				// 'qtips' => array( 'EE_Message_List_Table_Tips' ),
+				'require_nonce' => false,
+			],
+			'global_mtps'              => [
+				'nav'           => [
+					'label' => esc_html__('Default Message Templates', 'event_espresso'),
+					'icon' => 'dashicons-layout',
+					'order' => 20,
+				],
+				'list_table'    => 'Messages_Template_List_Table',
+				'help_tabs'     => [
+					'messages_overview_help_tab'                                => [
+						'title'    => esc_html__('Messages Overview', 'event_espresso'),
+						'filename' => 'messages_overview',
+					],
+					'messages_overview_messages_table_column_headings_help_tab' => [
+						'title'    => esc_html__('Messages Table Column Headings', 'event_espresso'),
+						'filename' => 'messages_overview_table_column_headings',
+					],
+					'messages_overview_messages_filters_help_tab'               => [
+						'title'    => esc_html__('Message Filters', 'event_espresso'),
+						'filename' => 'messages_overview_filters',
+					],
+					'messages_overview_messages_views_help_tab'                 => [
+						'title'    => esc_html__('Message Views', 'event_espresso'),
+						'filename' => 'messages_overview_views',
+					],
+					'message_overview_message_types_help_tab'                   => [
+						'title'    => esc_html__('Message Types', 'event_espresso'),
+						'filename' => 'messages_overview_types',
+					],
+					'messages_overview_messengers_help_tab'                     => [
+						'title'    => esc_html__('Messengers', 'event_espresso'),
+						'filename' => 'messages_overview_messengers',
+					],
+				],
+				'require_nonce' => false,
+			],
+			'custom_mtps'              => [
+				'nav'           => [
+					'label' => esc_html__('Custom Message Templates', 'event_espresso'),
+					'icon' => 'dashicons-admin-customizer',
+					'order' => 30,
+				],
+				'help_tabs'     => [],
+				'require_nonce' => false,
+			],
+			'add_new_message_template' => [
+				'nav'           => [
+					'label'      => esc_html__('Add New Message Templates', 'event_espresso'),
+					'icon' => 'dashicons-plus-alt',
+					'order'      => 5,
+					'persistent' => false,
+				],
+				'require_nonce' => false,
+			],
+			'edit_message_template'    => [
+				'labels'        => [
+					'buttons'    => [
+						'reset' => esc_html__('Reset Templates', 'event_espresso'),
+					],
+					'publishbox' => esc_html__('Update Actions', 'event_espresso'),
+				],
+				'nav'           => [
+					'label'      => esc_html__('Edit Message Templates', 'event_espresso'),
+					'icon' => 'dashicons-edit-large',
+					'order'      => 5,
+					'persistent' => false,
+					'url'        => '',
+				],
+				'metaboxes'     => ['_publish_post_box', '_register_edit_meta_boxes'],
+				'has_metaboxes' => true,
+				'help_tabs'     => [
+					'edit_message_template'            => [
+						'title'    => esc_html__('Message Template Editor', 'event_espresso'),
+						'callback' => 'edit_message_template_help_tab',
+					],
+					'message_templates_help_tab'       => [
+						'title'    => esc_html__('Message Templates', 'event_espresso'),
+						'filename' => 'messages_templates',
+					],
+					'message_template_shortcodes'      => [
+						'title'    => esc_html__('Message Shortcodes', 'event_espresso'),
+						'callback' => 'message_template_shortcodes_help_tab',
+					],
+					'message_preview_help_tab'         => [
+						'title'    => esc_html__('Message Preview', 'event_espresso'),
+						'filename' => 'messages_preview',
+					],
+					'messages_overview_other_help_tab' => [
+						'title'    => esc_html__('Messages Other', 'event_espresso'),
+						'filename' => 'messages_overview_other',
+					],
+				],
+				'require_nonce' => false,
+			],
+			'display_preview_message'  => [
+				'nav'           => [
+					'label'      => esc_html__('Message Preview', 'event_espresso'),
+					'icon' => 'dashicons-visibility-bar',
+					'order'      => 5,
+					'url'        => '',
+					'persistent' => false,
+				],
+				'help_tabs'     => [
+					'preview_message' => [
+						'title'    => esc_html__('About Previews', 'event_espresso'),
+						'callback' => 'preview_message_help_tab',
+					],
+				],
+				'require_nonce' => false,
+			],
+			'settings'                 => [
+				'nav'           => [
+					'label' => esc_html__('Settings', 'event_espresso'),
+					'icon' => 'dashicons-admin-generic',
+					'order' => 40,
+				],
+				'metaboxes'     => ['_messages_settings_metaboxes'],
+				'help_tabs'     => [
+					'messages_settings_help_tab'               => [
+						'title'    => esc_html__('Messages Settings', 'event_espresso'),
+						'filename' => 'messages_settings',
+					],
+					'messages_settings_message_types_help_tab' => [
+						'title'    => esc_html__('Activating / Deactivating Message Types', 'event_espresso'),
+						'filename' => 'messages_settings_message_types',
+					],
+					'messages_settings_messengers_help_tab'    => [
+						'title'    => esc_html__('Activating / Deactivating Messengers', 'event_espresso'),
+						'filename' => 'messages_settings_messengers',
+					],
+				],
+				'require_nonce' => false,
+			],
+		];
+	}
+
+
+	protected function _add_screen_options()
+	{
+		// todo
+	}
+
+
+	protected function _add_screen_options_global_mtps()
+	{
+		/**
+		 * Note: the reason for the value swap here on $this->_admin_page_title is because $this->_per_page_screen_options
+		 * uses the $_admin_page_title property and we want different outputs in the different spots.
+		 */
+		$page_title              = $this->_admin_page_title;
+		$this->_admin_page_title = esc_html__('Global Message Templates', 'event_espresso');
+		$this->_per_page_screen_option();
+		$this->_admin_page_title = $page_title;
+	}
+
+
+	protected function _add_screen_options_default()
+	{
+		$this->_admin_page_title = esc_html__('Message Activity', 'event_espresso');
+		$this->_per_page_screen_option();
+	}
+
+
+	// none of the below group are currently used for Messages
+	protected function _add_feature_pointers()
+	{
+	}
+
+
+	public function admin_init()
+	{
+	}
+
+
+	public function admin_notices()
+	{
+	}
+
+
+	public function admin_footer_scripts()
+	{
+	}
+
+
+	public function messages_help_tab()
+	{
+		EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_help_tab.template.php');
+	}
+
+
+	public function messengers_help_tab()
+	{
+		EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messenger_help_tab.template.php');
+	}
+
+
+	public function message_types_help_tab()
+	{
+		EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_message_type_help_tab.template.php');
+	}
+
+
+	public function messages_overview_help_tab()
+	{
+		EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_overview_help_tab.template.php');
+	}
+
+
+	public function message_templates_help_tab()
+	{
+		EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_message_templates_help_tab.template.php');
+	}
+
+
+	public function edit_message_template_help_tab()
+	{
+		$args['img1'] = '<img src="' . EE_MSG_ASSETS_URL . 'images/editor.png' . '" alt="'
+						. esc_attr__('Editor Title', 'event_espresso')
+						. '" />';
+		$args['img2'] = '<img src="' . EE_MSG_ASSETS_URL . 'images/switch-context.png' . '" alt="'
+						. esc_attr__('Context Switcher and Preview', 'event_espresso')
+						. '" />';
+		$args['img3'] = '<img class="left" src="' . EE_MSG_ASSETS_URL . 'images/form-fields.png' . '" alt="'
+						. esc_attr__('Message Template Form Fields', 'event_espresso')
+						. '" />';
+		$args['img4'] = '<img class="right" src="' . EE_MSG_ASSETS_URL . 'images/shortcodes-metabox.png' . '" alt="'
+						. esc_attr__('Shortcodes Metabox', 'event_espresso')
+						. '" />';
+		$args['img5'] = '<img class="right" src="' . EE_MSG_ASSETS_URL . 'images/publish-meta-box.png' . '" alt="'
+						. esc_attr__('Publish Metabox', 'event_espresso')
+						. '" />';
+		EEH_Template::display_template(
+			EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_templates_editor_help_tab.template.php',
+			$args
+		);
+	}
+
+
+	/**
+	 * @throws ReflectionException
+	 * @throws EE_Error
+	 */
+	public function message_template_shortcodes_help_tab()
+	{
+		$this->_set_shortcodes();
+		$args['shortcodes'] = $this->_shortcodes;
+		EEH_Template::display_template(
+			EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_shortcodes_help_tab.template.php',
+			$args
+		);
+	}
+
+
+	public function preview_message_help_tab()
+	{
+		EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_preview_help_tab.template.php');
+	}
+
+
+	public function settings_help_tab()
+	{
+		$args['img1'] = '<img class="inline-text" src="' . EE_MSG_ASSETS_URL . 'images/email-tab-active.png'
+						. '" alt="' . esc_attr__('Active Email Tab', 'event_espresso') . '" />';
+		$args['img2'] = '<img class="inline-text" src="' . EE_MSG_ASSETS_URL . 'images/email-tab-inactive.png'
+						. '" alt="' . esc_attr__('Inactive Email Tab', 'event_espresso') . '" />';
+		$args['img3'] = '<div class="switch">'
+						. '<input class="ee-on-off-toggle ee-toggle-round-flat"'
+						. ' type="checkbox" checked>'
+						. '<label for="ee-on-off-toggle-on"></label>'
+						. '</div>';
+		$args['img4'] = '<div class="switch">'
+						. '<input class="ee-on-off-toggle ee-toggle-round-flat"'
+						. ' type="checkbox">'
+						. '<label for="ee-on-off-toggle-on"></label>'
+						. '</div>';
+		EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_settings_help_tab.template.php', $args);
+	}
+
+
+	public function load_scripts_styles()
+	{
+		wp_register_style('espresso_ee_msg', EE_MSG_ASSETS_URL . 'ee_message_admin.css', EVENT_ESPRESSO_VERSION);
+		wp_enqueue_style('espresso_ee_msg');
+
+		wp_register_script(
+			'ee-messages-settings',
+			EE_MSG_ASSETS_URL . 'ee-messages-settings.js',
+			['jquery-ui-droppable', 'ee-serialize-full-array'],
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_register_script(
+			'ee-msg-list-table-js',
+			EE_MSG_ASSETS_URL . 'ee_message_admin_list_table.js',
+			['ee-dialog'],
+			EVENT_ESPRESSO_VERSION
+		);
+	}
+
+
+	public function load_scripts_styles_default()
+	{
+		wp_enqueue_script('ee-msg-list-table-js');
+	}
+
+
+	public function wp_editor_css($mce_css)
+	{
+		// if we're on the edit_message_template route
+		if ($this->_req_action === 'edit_message_template' && $this->_active_messenger instanceof EE_messenger) {
+			$message_type_name = $this->_active_message_type_name;
+
+			// we're going to REPLACE the existing mce css
+			// we need to get the css file location from the active messenger
+			$mce_css = $this->_active_messenger->get_variation(
+				$this->_template_pack,
+				$message_type_name,
+				true,
+				'wpeditor',
+				$this->_variation
+			);
+		}
+
+		return $mce_css;
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function load_scripts_styles_edit_message_template()
+	{
+
+		$this->_set_shortcodes();
+
+		EE_Registry::$i18n_js_strings['confirm_default_reset']        = sprintf(
+			esc_html__(
+				'Are you sure you want to reset the %s %s message templates?  Remember continuing will reset the templates for all contexts in this messenger and message type group.',
+				'event_espresso'
+			),
+			$this->_message_template_group->messenger_obj()->label['singular'],
+			$this->_message_template_group->message_type_obj()->label['singular']
+		);
+		EE_Registry::$i18n_js_strings['confirm_switch_template_pack'] = esc_html__(
+			'Switching the template pack for a messages template will reset the content for the template so the new layout is loaded.  Any custom content in the existing template will be lost. Are you sure you wish to do this?',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['server_error']                 = esc_html__(
+			'An unknown error occurred on the server while attempting to process your request. Please refresh the page and try again or contact support.',
+			'event_espresso'
+		);
+
+		wp_register_script(
+			'ee_msgs_edit_js',
+			EE_MSG_ASSETS_URL . 'ee_message_editor.js',
+			['jquery'],
+			EVENT_ESPRESSO_VERSION
+		);
+
+		wp_enqueue_script('ee_admin_js');
+		wp_enqueue_script('ee_msgs_edit_js');
+
+		// add in special css for tiny_mce
+		add_filter('mce_css', [$this, 'wp_editor_css']);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function load_scripts_styles_display_preview_message()
+	{
+		$this->_set_message_template_group();
+		if ($this->_active_messenger_name) {
+			$this->_active_messenger = $this->_message_resource_manager->get_active_messenger(
+				$this->_active_messenger_name
+			);
+		}
+
+		wp_enqueue_style(
+			'espresso_preview_css',
+			$this->_active_messenger->get_variation(
+				$this->_template_pack,
+				$this->_active_message_type_name,
+				true,
+				'preview',
+				$this->_variation
+			)
+		);
+	}
+
+
+	public function load_scripts_styles_settings()
+	{
+		wp_register_style(
+			'ee-message-settings',
+			EE_MSG_ASSETS_URL . 'ee_message_settings.css',
+			[],
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('ee-text-links');
+		wp_enqueue_style('ee-message-settings');
+		wp_enqueue_script('ee-messages-settings');
+	}
+
+
+	/**
+	 * set views array for List Table
+	 */
+	public function _set_list_table_views_global_mtps()
+	{
+		$this->_views = [
+			'in_use' => [
+				'slug'  => 'in_use',
+				'label' => esc_html__('In Use', 'event_espresso'),
+				'count' => 0,
+			],
+		];
+	}
+
+
+	/**
+	 * Set views array for the Custom Template List Table
+	 */
+	public function _set_list_table_views_custom_mtps()
+	{
+		$this->_set_list_table_views_global_mtps();
+		$this->_views['in_use']['bulk_action'] = [
+			'trash_message_template' => esc_html__('Move to Trash', 'event_espresso'),
+		];
+	}
+
+
+	/**
+	 * set views array for message queue list table
+	 *
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function _set_list_table_views_default()
+	{
+		EE_Registry::instance()->load_helper('Template');
+
+		$common_bulk_actions = EE_Registry::instance()->CAP->current_user_can(
+			'ee_send_message',
+			'message_list_table_bulk_actions'
+		)
+			? [
+				'generate_now'          => esc_html__('Generate Now', 'event_espresso'),
+				'generate_and_send_now' => esc_html__('Generate and Send Now', 'event_espresso'),
+				'queue_for_resending'   => esc_html__('Queue for Resending', 'event_espresso'),
+				'send_now'              => esc_html__('Send Now', 'event_espresso'),
+			]
+			: [];
+
+		$delete_bulk_action = EE_Registry::instance()->CAP->current_user_can(
+			'ee_delete_messages',
+			'message_list_table_bulk_actions'
+		)
+			? ['delete_ee_messages' => esc_html__('Delete Messages', 'event_espresso')]
+			: [];
+
+
+		$this->_views = [
+			'all' => [
+				'slug'        => 'all',
+				'label'       => esc_html__('All', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array_merge($common_bulk_actions, $delete_bulk_action),
+			],
+		];
+
+
+		foreach ($this->getMsgModel()->all_statuses() as $status) {
+			if ($status === EEM_Message::status_debug_only && ! EEM_Message::debug()) {
+				continue;
+			}
+			$status_bulk_actions = $common_bulk_actions;
+			// unset bulk actions not applying to status
+			if (! empty($status_bulk_actions)) {
+				switch ($status) {
+					case EEM_Message::status_idle:
+					case EEM_Message::status_resend:
+						$status_bulk_actions['send_now'] = $common_bulk_actions['send_now'];
+						break;
+
+					case EEM_Message::status_failed:
+					case EEM_Message::status_debug_only:
+					case EEM_Message::status_messenger_executing:
+						$status_bulk_actions = [];
+						break;
+
+					case EEM_Message::status_incomplete:
+						unset($status_bulk_actions['queue_for_resending'], $status_bulk_actions['send_now']);
+						break;
+
+					case EEM_Message::status_retry:
+					case EEM_Message::status_sent:
+						unset($status_bulk_actions['generate_now'], $status_bulk_actions['generate_and_send_now']);
+						break;
+				}
+			}
+
+			// skip adding messenger executing status to views because it will be included with the Failed view.
+			if ($status === EEM_Message::status_messenger_executing) {
+				continue;
+			}
+
+			$this->_views[ strtolower($status) ] = [
+				'slug'        => strtolower($status),
+				'label'       => EEH_Template::pretty_status($status, false, 'sentence'),
+				'count'       => 0,
+				'bulk_action' => array_merge($status_bulk_actions, $delete_bulk_action),
+			];
+		}
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	protected function _ee_default_messages_overview_list_table()
+	{
+		$this->_admin_page_title = esc_html__('Default Message Templates', 'event_espresso');
+		$this->display_admin_list_table_page_with_no_sidebar();
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _message_queue_list_table()
+	{
+		$this->_search_btn_label                   = esc_html__('Message Activity', 'event_espresso');
+		$this->_template_args['per_column']        = 6;
+		$this->_template_args['after_list_table']  = $this->_display_legend($this->_message_legend_items());
+		$message_results = trim(EEM_Message::instance()->get_pretty_label_for_results());
+		$this->_template_args['before_list_table'] = ! empty($message_results) ? "<h3>{$message_results}</h3>" : '';
+		$this->display_admin_list_table_page_with_no_sidebar();
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	protected function _message_legend_items()
+	{
+
+		$action_css_classes = EEH_MSG_Template::get_message_action_icons();
+		$action_items       = [];
+
+		foreach ($action_css_classes as $action_item => $action_details) {
+			if ($action_item === 'see_notifications_for') {
+				continue;
+			}
+			$action_items[ $action_item ] = [
+				'class' => $action_details['css_class'],
+				'desc'  => $action_details['label'],
+			];
+		}
+
+		/** @var array $status_items status legend setup */
+		$status_items = [
+			'sent_status'                => [
+				'class' => 'ee-status-legend ee-status-bg--' . EEM_Message::status_sent,
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_sent, false, 'sentence'),
+			],
+			'idle_status'                => [
+				'class' => 'ee-status-legend ee-status-bg--' . EEM_Message::status_idle,
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_idle, false, 'sentence'),
+			],
+			'failed_status'              => [
+				'class' => 'ee-status-legend ee-status-bg--' . EEM_Message::status_failed,
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_failed, false, 'sentence'),
+			],
+			'messenger_executing_status' => [
+				'class' => 'ee-status-legend ee-status-bg--' . EEM_Message::status_messenger_executing,
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_messenger_executing, false, 'sentence'),
+			],
+			'resend_status'              => [
+				'class' => 'ee-status-legend ee-status-bg--' . EEM_Message::status_resend,
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_resend, false, 'sentence'),
+			],
+			'incomplete_status'          => [
+				'class' => 'ee-status-legend ee-status-bg--' . EEM_Message::status_incomplete,
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_incomplete, false, 'sentence'),
+			],
+			'retry_status'               => [
+				'class' => 'ee-status-legend ee-status-bg--' . EEM_Message::status_retry,
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_retry, false, 'sentence'),
+			],
+		];
+		if (EEM_Message::debug()) {
+			$status_items['debug_only_status'] = [
+				'class' => 'ee-status-legend ee-status-bg--' . EEM_Message::status_debug_only,
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_debug_only, false, 'sentence'),
+			];
+		}
+
+		return array_merge($action_items, $status_items);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	protected function _custom_mtps_preview()
+	{
+		$this->_admin_page_title              = esc_html__('Custom Message Templates (Preview)', 'event_espresso');
+		$this->_template_args['preview_img']  = '<img src="' . EE_MSG_ASSETS_URL . 'images/custom_mtps_preview.png"'
+												. ' alt="' . esc_attr__(
+													'Preview Custom Message Templates screenshot',
+													'event_espresso'
+												) . '" />';
+		$this->_template_args['preview_text'] = '<strong>'
+												. esc_html__(
+													'Custom Message Templates is a feature that is only available in the premium version of Event Espresso 4 which is available with a support license purchase on EventEspresso.com. With the Custom Message Templates feature, you are able to create custom message templates and assign them on a per-event basis.',
+													'event_espresso'
+												)
+												. '</strong>';
+
+		$this->display_admin_caf_preview_page('custom_message_types', false);
+	}
+
+
+	/**
+	 * get_message_templates
+	 * This gets all the message templates for listing on the overview list.
+	 *
+	 * @access public
+	 * @param int    $per_page the amount of templates groups to show per page
+	 * @param string $type     the current _view we're getting templates for
+	 * @param bool   $count    return count?
+	 * @param bool   $all      disregard any paging info (get all data);
+	 * @param bool   $global   whether to return just global (true) or custom templates (false)
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_message_templates(
+		$per_page = 10,
+		$type = 'in_use',
+		$count = false,
+		$all = false,
+		$global = true
+	) {
+		$orderby = $this->request->getRequestParam('orderby', 'GRP_ID');
+		$this->request->setRequestParam('orderby', $orderby);
+
+		$order        = $this->request->getRequestParam('order', 'ASC');
+		$current_page = $this->request->getRequestParam('paged', 1, 'int');
+		$per_page     = $this->request->getRequestParam('perpage', $per_page, 'int');
+
+		$offset = ($current_page - 1) * $per_page;
+		$limit  = $all ? null : [$offset, $per_page];
+
+		// options will match what is in the _views array property
+		return $type === 'in_use'
+			? $this->getMtgModel()->get_all_active_message_templates(
+				$orderby,
+				$order,
+				$limit,
+				$count,
+				$global,
+				true
+			)
+			: $this->getMtgModel()->get_all_trashed_grouped_message_templates(
+				$orderby,
+				$order,
+				$limit,
+				$count,
+				$global
+			);
+	}
+
+
+	/**
+	 * filters etc might need a list of installed message_types
+	 *
+	 * @return array an array of message type objects
+	 */
+	public function get_installed_message_types()
+	{
+		$installed_message_types = $this->_message_resource_manager->installed_message_types();
+		$installed               = [];
+
+		foreach ($installed_message_types as $message_type) {
+			$installed[ $message_type->name ] = $message_type;
+		}
+
+		return $installed;
+	}
+
+
+	/**
+	 * This is used when creating a custom template. All Custom Templates start based off another template.
+	 *
+	 * @param string $message_type
+	 * @param string $messenger
+	 * @param string $GRP_ID
+	 *
+	 * @throws EE_error
+	 * @throws ReflectionException
+	 */
+	public function add_message_template($message_type = '', $messenger = '', $GRP_ID = '')
+	{
+		// set values override any request data
+		$message_type = ! empty($message_type) ? $message_type : $this->_active_message_type_name;
+		$messenger    = ! empty($messenger) ? $messenger : $this->_active_messenger_name;
+		$GRP_ID       = ! empty($GRP_ID) ? $GRP_ID : $this->request->getRequestParam('GRP_ID', 0, 'int');
+
+		// we need messenger and message type.  They should be coming from the event editor. If not here then return error
+		if (empty($message_type) || empty($messenger)) {
+			throw new EE_Error(
+				esc_html__(
+					'Sorry, but we can\'t create new templates because we\'re missing the messenger or message type',
+					'event_espresso'
+				)
+			);
+		}
+
+		// we need the GRP_ID for the template being used as the base for the new template
+		if (empty($GRP_ID)) {
+			throw new EE_Error(
+				esc_html__(
+					'In order to create a custom message template the GRP_ID of the template being used as a base is needed',
+					'event_espresso'
+				)
+			);
+		}
+
+		// let's just make sure the template gets generated!
+
+		// we need to reassign some variables for what the insert is expecting
+		$this->request->setRequestParam('MTP_messenger', $messenger);
+		$this->request->setRequestParam('MTP_message_type', $message_type);
+		$this->request->setRequestParam('GRP_ID', $GRP_ID);
+
+		$this->_insert_or_update_message_template(true);
+	}
+
+
+	/**
+	 * @param string $message_type     message type slug
+	 * @param string $messenger        messenger slug
+	 * @param int    $GRP_ID           GRP_ID for the related message template group this new template will be based
+	 *                                 off of.
+	 * @throws EE_error
+	 * @throws ReflectionException
+	 * @deprecated 4.10.29.p
+	 */
+	protected function _add_message_template($message_type, $messenger, $GRP_ID)
+	{
+		$this->add_message_template($message_type, $messenger, $GRP_ID);
+	}
+
+
+	/**
+	 * _edit_message_template
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws InvalidIdentifierException
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _edit_message_template()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$template_fields = '';
+		$sidebar_fields  = '';
+		// we filter the tinyMCE settings to remove the validation since message templates by their nature will not have
+		// valid html in the templates.
+		add_filter('tiny_mce_before_init', [$this, 'filter_tinymce_init'], 10, 2);
+
+		$GRP_ID = $this->request->getRequestParam('id', 0, 'int');
+		$EVT_ID = $this->request->getRequestParam('evt_id', 0, 'int');
+
+		$this->_set_shortcodes(); // this also sets the _message_template property.
+		$message_template_group = $this->_message_template_group;
+		$c_label                = $message_template_group->context_label();
+		$c_config               = $message_template_group->contexts_config();
+
+		reset($c_config);
+		$context = $this->request->getRequestParam('context', key($c_config));
+		$context = strtolower($context);
+
+		$action = empty($GRP_ID) ? 'insert_message_template' : 'update_message_template';
+
+		$edit_message_template_form_url = add_query_arg(
+			['action' => $action, 'noheader' => true],
+			EE_MSG_ADMIN_URL
+		);
+
+		// set active messenger for this view
+		$this->_active_messenger         = $this->_message_resource_manager->get_active_messenger(
+			$message_template_group->messenger()
+		);
+		$this->_active_message_type_name = $message_template_group->message_type();
+
+
+		// Do we have any validation errors?
+		$validators = $this->_get_transient();
+		$v_fields   = ! empty($validators) ? array_keys($validators) : [];
+
+
+		// we need to assemble the title from Various details
+		$context_label = sprintf(
+			esc_html__('(%s %s)', 'event_espresso'),
+			$c_config[ $context ]['label'],
+			ucwords($c_label['label'])
+		);
+
+		$title = sprintf(
+			esc_html__(' %s %s Template %s', 'event_espresso'),
+			ucwords($message_template_group->messenger_obj()->label['singular']),
+			ucwords($message_template_group->message_type_obj()->label['singular']),
+			$context_label
+		);
+
+		$this->_template_args['GRP_ID']           = $GRP_ID;
+		$this->_template_args['message_template'] = $message_template_group;
+		$this->_template_args['is_extra_fields']  = false;
+
+
+		// let's get EEH_MSG_Template so we can get template form fields
+		$template_field_structure = EEH_MSG_Template::get_fields(
+			$message_template_group->messenger(),
+			$message_template_group->message_type()
+		);
+
+		if (! $template_field_structure) {
+			$template_field_structure = false;
+			$template_fields          = esc_html__(
+				'There was an error in assembling the fields for this display (you should see an error message)',
+				'event_espresso'
+			);
+		}
+
+
+		$message_templates = $message_template_group->context_templates();
+
+
+		// if we have the extra key.. then we need to remove the content index from the template_field_structure as it
+		// will get handled in the "extra" array.
+		if (is_array($template_field_structure[ $context ]) && isset($template_field_structure[ $context ]['extra'])) {
+			foreach ($template_field_structure[ $context ]['extra'] as $reference_field => $new_fields) {
+				unset($template_field_structure[ $context ][ $reference_field ]);
+			}
+		}
+
+		// let's loop through the template_field_structure and actually assemble the input fields!
+		if (! empty($template_field_structure)) {
+			foreach ($template_field_structure[ $context ] as $template_field => $field_setup_array) {
+				// if this is an 'extra' template field then we need to remove any existing fields that are keyed up in
+				// the extra array and reset them.
+				if ($template_field === 'extra') {
+					$this->_template_args['is_extra_fields'] = true;
+					foreach ($field_setup_array as $reference_field => $new_fields_array) {
+						$message_template = $message_templates[ $context ][ $reference_field ];
+						$content          = $message_template instanceof EE_Message_Template
+							? $message_template->get('MTP_content')
+							: '';
+						foreach ($new_fields_array as $extra_field => $extra_array) {
+							// let's verify if we need this extra field via the shortcodes parameter.
+							$continue = false;
+							if (isset($extra_array['shortcodes_required'])) {
+								foreach ((array) $extra_array['shortcodes_required'] as $shortcode) {
+									if (! array_key_exists($shortcode, $this->_shortcodes)) {
+										$continue = true;
+									}
+								}
+								if ($continue) {
+									continue;
+								}
+							}
+
+							$field_id = $reference_field . '-' . $extra_field . '-content';
+
+							$template_form_fields[ $field_id ]         = $extra_array;
+							$template_form_fields[ $field_id ]['name'] = 'MTP_template_fields['
+																		 . $reference_field
+																		 . '][content]['
+																		 . $extra_field . ']';
+							$css_class                                 = isset($extra_array['css_class'])
+								? $extra_array['css_class']
+								: '';
+
+							$template_form_fields[ $field_id ]['css_class'] = ! empty($v_fields)
+																			  && in_array($extra_field, $v_fields, true)
+																			  && (
+																				  is_array($validators[ $extra_field ])
+																				  && isset($validators[ $extra_field ]['msg'])
+																			  )
+								? 'validate-error ' . $css_class
+								: $css_class;
+
+							$template_form_fields[ $field_id ]['value'] = ! empty($message_templates)
+																		  && isset($content[ $extra_field ])
+								? $content[ $extra_field ]
+								: '';
+
+							// do we have a validation error?  if we do then let's use that value instead
+							$template_form_fields[ $field_id ]['value'] = isset($validators[ $extra_field ])
+								? $validators[ $extra_field ]['value']
+								: $template_form_fields[ $field_id ]['value'];
+
+
+							$template_form_fields[ $field_id ]['db-col'] = 'MTP_content';
+
+							// shortcode selector
+							$field_name_to_use                                   = $extra_field === 'main'
+								? 'content'
+								: $extra_field;
+							$template_form_fields[ $field_id ]['append_content'] = $this->_get_shortcode_selector(
+								$field_name_to_use,
+								$field_id
+							);
+						}
+						$template_field_MTP_id           = $reference_field . '-MTP_ID';
+						$template_field_template_name_id = $reference_field . '-name';
+
+						$template_form_fields[ $template_field_MTP_id ] = [
+							'name'       => 'MTP_template_fields[' . $reference_field . '][MTP_ID]',
+							'label'      => null,
+							'input'      => 'hidden',
+							'type'       => 'int',
+							'required'   => false,
+							'validation' => false,
+							'value'      => ! empty($message_templates) ? $message_template->ID() : '',
+							'css_class'  => '',
+							'format'     => '%d',
+							'db-col'     => 'MTP_ID',
+						];
+
+						$template_form_fields[ $template_field_template_name_id ] = [
+							'name'       => 'MTP_template_fields[' . $reference_field . '][name]',
+							'label'      => null,
+							'input'      => 'hidden',
+							'type'       => 'string',
+							'required'   => false,
+							'validation' => true,
+							'value'      => $reference_field,
+							'css_class'  => '',
+							'format'     => '%s',
+							'db-col'     => 'MTP_template_field',
+						];
+					}
+					continue; // skip the next stuff, we got the necessary fields here for this dataset.
+				} else {
+					$field_id                                   = $template_field . '-content';
+					$template_form_fields[ $field_id ]          = $field_setup_array;
+					$template_form_fields[ $field_id ]['name']  =
+						'MTP_template_fields[' . $template_field . '][content]';
+					$message_template                           =
+						isset($message_templates[ $context ][ $template_field ])
+							? $message_templates[ $context ][ $template_field ]
+							: null;
+					$template_form_fields[ $field_id ]['value'] = ! empty($message_templates)
+																  && is_array($message_templates[ $context ])
+																  && $message_template instanceof EE_Message_Template
+						? $message_template->get('MTP_content')
+						: '';
+
+					// do we have a validator error for this field?  if we do then we'll use that value instead
+					$template_form_fields[ $field_id ]['value'] = isset($validators[ $template_field ])
+						? $validators[ $template_field ]['value']
+						: $template_form_fields[ $field_id ]['value'];
+
+
+					$template_form_fields[ $field_id ]['db-col']    = 'MTP_content';
+					$css_class                                      = isset($field_setup_array['css_class'])
+						? $field_setup_array['css_class']
+						: '';
+					$template_form_fields[ $field_id ]['css_class'] = ! empty($v_fields)
+																	  && in_array($template_field, $v_fields, true)
+																	  && isset($validators[ $template_field ]['msg'])
+						? 'validate-error ' . $css_class
+						: $css_class;
+
+					// shortcode selector
+					$template_form_fields[ $field_id ]['append_content'] = $this->_get_shortcode_selector(
+						$template_field,
+						$field_id
+					);
+				}
+
+				// k took care of content field(s) now let's take care of others.
+
+				$template_field_MTP_id                 = $template_field . '-MTP_ID';
+				$template_field_field_template_name_id = $template_field . '-name';
+
+				// foreach template field there are actually two form fields created
+				$template_form_fields[ $template_field_MTP_id ] = [
+					'name'       => 'MTP_template_fields[' . $template_field . '][MTP_ID]',
+					'label'      => null,
+					'input'      => 'hidden',
+					'type'       => 'int',
+					'required'   => false,
+					'validation' => true,
+					'value'      => $message_template instanceof EE_Message_Template ? $message_template->ID() : '',
+					'css_class'  => '',
+					'format'     => '%d',
+					'db-col'     => 'MTP_ID',
+				];
+
+				$template_form_fields[ $template_field_field_template_name_id ] = [
+					'name'       => 'MTP_template_fields[' . $template_field . '][name]',
+					'label'      => null,
+					'input'      => 'hidden',
+					'type'       => 'string',
+					'required'   => false,
+					'validation' => true,
+					'value'      => $template_field,
+					'css_class'  => '',
+					'format'     => '%s',
+					'db-col'     => 'MTP_template_field',
+				];
+			}
+
+			// add other fields
+			$template_form_fields['ee-msg-current-context'] = [
+				'name'       => 'MTP_context',
+				'label'      => null,
+				'input'      => 'hidden',
+				'type'       => 'string',
+				'required'   => false,
+				'validation' => true,
+				'value'      => $context,
+				'css_class'  => '',
+				'format'     => '%s',
+				'db-col'     => 'MTP_context',
+			];
+
+			$template_form_fields['ee-msg-grp-id'] = [
+				'name'       => 'GRP_ID',
+				'label'      => null,
+				'input'      => 'hidden',
+				'type'       => 'int',
+				'required'   => false,
+				'validation' => true,
+				'value'      => $GRP_ID,
+				'css_class'  => '',
+				'format'     => '%d',
+				'db-col'     => 'GRP_ID',
+			];
+
+			$template_form_fields['ee-msg-messenger'] = [
+				'name'       => 'MTP_messenger',
+				'label'      => null,
+				'input'      => 'hidden',
+				'type'       => 'string',
+				'required'   => false,
+				'validation' => true,
+				'value'      => $message_template_group->messenger(),
+				'css_class'  => '',
+				'format'     => '%s',
+				'db-col'     => 'MTP_messenger',
+			];
+
+			$template_form_fields['ee-msg-message-type'] = [
+				'name'       => 'MTP_message_type',
+				'label'      => null,
+				'input'      => 'hidden',
+				'type'       => 'string',
+				'required'   => false,
+				'validation' => true,
+				'value'      => $message_template_group->message_type(),
+				'css_class'  => '',
+				'format'     => '%s',
+				'db-col'     => 'MTP_message_type',
+			];
+
+			$sidebar_form_fields['ee-msg-is-global'] = [
+				'name'       => 'MTP_is_global',
+				'label'      => esc_html__('Global Template', 'event_espresso'),
+				'input'      => 'hidden',
+				'type'       => 'int',
+				'required'   => false,
+				'validation' => true,
+				'value'      => $message_template_group->get('MTP_is_global'),
+				'css_class'  => '',
+				'format'     => '%d',
+				'db-col'     => 'MTP_is_global',
+			];
+
+			$sidebar_form_fields['ee-msg-is-override'] = [
+				'name'       => 'MTP_is_override',
+				'label'      => esc_html__('Override all custom', 'event_espresso'),
+				'input'      => $message_template_group->is_global() ? 'checkbox' : 'hidden',
+				'type'       => 'int',
+				'required'   => false,
+				'validation' => true,
+				'value'      => $message_template_group->get('MTP_is_override'),
+				'css_class'  => '',
+				'format'     => '%d',
+				'db-col'     => 'MTP_is_override',
+			];
+
+			$sidebar_form_fields['ee-msg-is-active'] = [
+				'name'       => 'MTP_is_active',
+				'label'      => esc_html__('Active Template', 'event_espresso'),
+				'input'      => 'hidden',
+				'type'       => 'int',
+				'required'   => false,
+				'validation' => true,
+				'value'      => $message_template_group->is_active(),
+				'css_class'  => '',
+				'format'     => '%d',
+				'db-col'     => 'MTP_is_active',
+			];
+
+			$sidebar_form_fields['ee-msg-deleted'] = [
+				'name'       => 'MTP_deleted',
+				'label'      => null,
+				'input'      => 'hidden',
+				'type'       => 'int',
+				'required'   => false,
+				'validation' => true,
+				'value'      => $message_template_group->get('MTP_deleted'),
+				'css_class'  => '',
+				'format'     => '%d',
+				'db-col'     => 'MTP_deleted',
+			];
+			$sidebar_form_fields['ee-msg-author']  = [
+				'name'       => 'MTP_user_id',
+				'label'      => esc_html__('Author', 'event_espresso'),
+				'input'      => 'hidden',
+				'type'       => 'int',
+				'required'   => false,
+				'validation' => false,
+				'value'      => $message_template_group->user(),
+				'format'     => '%d',
+				'db-col'     => 'MTP_user_id',
+			];
+
+			$sidebar_form_fields['ee-msg-route'] = [
+				'name'  => 'action',
+				'input' => 'hidden',
+				'type'  => 'string',
+				'value' => $action,
+			];
+
+			$sidebar_form_fields['ee-msg-id']        = [
+				'name'  => 'id',
+				'input' => 'hidden',
+				'type'  => 'int',
+				'value' => $GRP_ID,
+			];
+			$sidebar_form_fields['ee-msg-evt-nonce'] = [
+				'name'  => $action . '_nonce',
+				'input' => 'hidden',
+				'type'  => 'string',
+				'value' => wp_create_nonce($action . '_nonce'),
+			];
+
+			$template_switch = $this->request->getRequestParam('template_switch');
+			if ($template_switch) {
+				$sidebar_form_fields['ee-msg-template-switch'] = [
+					'name'  => 'template_switch',
+					'input' => 'hidden',
+					'type'  => 'int',
+					'value' => 1,
+				];
+			}
+
+
+			$template_fields = $this->_generate_admin_form_fields($template_form_fields);
+			$sidebar_fields  = $this->_generate_admin_form_fields($sidebar_form_fields);
+		} //end if ( !empty($template_field_structure) )
+
+		// set extra content for publish box
+		$this->_template_args['publish_box_extra_content'] = $sidebar_fields;
+		$this->_set_publish_post_box_vars(
+			'id',
+			$GRP_ID,
+			false,
+			add_query_arg(
+				['action' => 'global_mtps'],
+				$this->_admin_base_url
+			)
+		);
+
+		// add preview button
+		$preview_url    = parent::add_query_args_and_nonce(
+			[
+				'message_type' => $message_template_group->message_type(),
+				'messenger'    => $message_template_group->messenger(),
+				'context'      => $context,
+				'GRP_ID'       => $GRP_ID,
+				'evt_id'       => $EVT_ID ?: false,
+				'action'       => 'preview_message',
+			],
+			$this->_admin_base_url
+		);
+		$preview_button = '<a href="' . $preview_url . '" class="button--secondary messages-preview-button">'
+						  . esc_html__('Preview', 'event_espresso')
+						  . '</a>';
+
+
+		// setup context switcher
+		$this->_set_context_switcher(
+			$message_template_group,
+			[
+				'page'    => 'espresso_messages',
+				'action'  => 'edit_message_template',
+				'id'      => $GRP_ID,
+				'evt_id'  => $EVT_ID,
+				'context' => $context,
+				'extra'   => $preview_button,
+			]
+		);
+
+
+		// main box
+		$this->_template_args['template_fields']                         = $template_fields;
+		$this->_template_args['sidebar_box_id']                          = 'details';
+		$this->_template_args['action']                                  = $action;
+		$this->_template_args['context']                                 = $context;
+		$this->_template_args['edit_message_template_form_url']          = $edit_message_template_form_url;
+		$this->_template_args['learn_more_about_message_templates_link'] =
+			$this->_learn_more_about_message_templates_link();
+
+
+		$this->_template_args['before_admin_page_content'] = '<div class="ee-msg-admin-header">';
+		$this->_template_args['before_admin_page_content'] .= $this->add_active_context_element(
+			$message_template_group,
+			$context,
+			$context_label
+		);
+		$this->_template_args['before_admin_page_content'] .= $this->add_context_switcher();
+		$this->_template_args['before_admin_page_content'] .= '</div>';
+		$this->_template_args['before_admin_page_content'] .= $this->_add_form_element_before();
+		$this->_template_args['after_admin_page_content']  = $this->_add_form_element_after();
+
+		$this->_template_path = $this->_template_args['GRP_ID']
+			? EE_MSG_TEMPLATE_PATH . 'ee_msg_details_main_edit_meta_box.template.php'
+			: EE_MSG_TEMPLATE_PATH . 'ee_msg_details_main_add_meta_box.template.php';
+
+		// send along EE_Message_Template_Group object for further template use.
+		$this->_template_args['MTP'] = $message_template_group;
+
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			$this->_template_path,
+			$this->_template_args,
+			true
+		);
+
+
+		// finally, let's set the admin_page title
+		$this->_admin_page_title = sprintf(esc_html__('Editing %s', 'event_espresso'), $title);
+
+
+		// we need to take care of setting the shortcodes property for use elsewhere.
+		$this->_set_shortcodes();
+
+
+		// final template wrapper
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	public function filter_tinymce_init($mceInit, $editor_id)
+	{
+		return $mceInit;
+	}
+
+
+	public function add_context_switcher()
+	{
+		return $this->_context_switcher;
+	}
+
+
+	/**
+	 * Adds the activation/deactivation toggle for the message template context.
+	 *
+	 * @param EE_Message_Template_Group $message_template_group
+	 * @param string                    $context
+	 * @param string                    $context_label
+	 * @return string
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidIdentifierException
+	 * @throws ReflectionException
+	 */
+	protected function add_active_context_element(
+		EE_Message_Template_Group $message_template_group,
+		$context,
+		$context_label
+	) {
+		$template_args = [
+			'context'                   => $context,
+			'nonce'                     => wp_create_nonce('activate_' . $context . '_toggle_nonce'),
+			'is_active'                 => $message_template_group->is_context_active($context),
+			'on_off_action'             => $message_template_group->is_context_active($context)
+				? 'context-off'
+				: 'context-on',
+			'context_label'             => str_replace(['(', ')'], '', $context_label),
+			'message_template_group_id' => $message_template_group->ID(),
+		];
+		return EEH_Template::display_template(
+			EE_MSG_TEMPLATE_PATH . 'ee_msg_editor_active_context_element.template.php',
+			$template_args,
+			true
+		);
+	}
+
+
+	/**
+	 * Ajax callback for `toggle_context_template` ajax action.
+	 * Handles toggling the message context on or off.
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidIdentifierException
+	 * @throws InvalidInterfaceException
+	 */
+	public function toggle_context_template()
+	{
+		$success = true;
+		// check for required data
+		if (
+			! (
+				$this->request->requestParamIsSet('message_template_group_id')
+				&& $this->request->requestParamIsSet('context')
+				&& $this->request->requestParamIsSet('status')
+			)
+		) {
+			EE_Error::add_error(
+				esc_html__('Required data for doing this action is not available.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$success = false;
+		}
+
+		$nonce   = $this->request->getRequestParam('toggle_context_nonce', '');
+		$context = $this->request->getRequestParam('context', '');
+		$status  = $this->request->getRequestParam('status', '');
+
+		$this->_verify_nonce($nonce, "activate_{$context}_toggle_nonce");
+
+		if ($status !== 'off' && $status !== 'on') {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__('The given status (%s) is not valid. Must be "off" or "on"', 'event_espresso'),
+					$status
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$success = false;
+		}
+		$message_template_group_id = $this->request->getRequestParam('message_template_group_id', 0, 'int');
+		$message_template_group    = $this->getMtgModel()->get_one_by_ID($message_template_group_id);
+		if (! $message_template_group instanceof EE_Message_Template_Group) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'Unable to change the active state because the given id "%1$d" does not match a valid "%2$s"',
+						'event_espresso'
+					),
+					$message_template_group_id,
+					'EE_Message_Template_Group'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$success = false;
+		}
+		if ($success) {
+			$success = $status === 'off'
+				? $message_template_group->deactivate_context($context)
+				: $message_template_group->activate_context($context);
+		}
+		$this->_template_args['success'] = $success;
+		$this->_return_json();
+	}
+
+
+	public function _add_form_element_before()
+	{
+		return '<form method="post" action="'
+			   . $this->_template_args['edit_message_template_form_url']
+			   . '" id="ee-msg-edit-frm">';
+	}
+
+
+	public function _add_form_element_after()
+	{
+		return '</form>';
+	}
+
+
+	/**
+	 * This executes switching the template pack for a message template.
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @since 4.5.0
+	 */
+	public function switch_template_pack()
+	{
+
+		$GRP_ID        = $this->request->getRequestParam('GRP_ID', 0, 'int');
+		$template_pack = $this->request->getRequestParam('template_pack', '');
+
+		// verify we have needed values.
+		if (empty($GRP_ID) || empty($template_pack)) {
+			$this->_template_args['error'] = true;
+			EE_Error::add_error(
+				esc_html__('The required date for switching templates is not available.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		} else {
+			// get template, set the new template_pack and then reset to default
+			/** @var EE_Message_Template_Group $message_template_group */
+			$message_template_group = $this->getMtgModel()->get_one_by_ID($GRP_ID);
+
+			$message_template_group->set_template_pack_name($template_pack);
+			$this->request->setRequestParam('msgr', $message_template_group->messenger());
+			$this->request->setRequestParam('mt', $message_template_group->message_type());
+
+			$query_args = $this->_reset_to_default_template();
+
+			if (empty($query_args['id'])) {
+				EE_Error::add_error(
+					esc_html__(
+						'Something went wrong with switching the template pack. Please try again or contact EE support',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				$this->_template_args['error'] = true;
+			} else {
+				$template_label       = $message_template_group->get_template_pack()->label;
+				$template_pack_labels = $message_template_group->messenger_obj()->get_supports_labels();
+				EE_Error::add_success(
+					sprintf(
+						esc_html__(
+							'This message template has been successfully switched to use the %1$s %2$s.  Please wait while the page reloads with your new template.',
+							'event_espresso'
+						),
+						$template_label,
+						$template_pack_labels->template_pack
+					)
+				);
+				// generate the redirect url for js.
+				$url = self::add_query_args_and_nonce($query_args, $this->_admin_base_url);
+
+				$this->_template_args['data']['redirect_url'] = $url;
+				$this->_template_args['success']              = true;
+			}
+
+			$this->_return_json();
+		}
+	}
+
+
+	/**
+	 * This handles resetting the template for the given messenger/message_type so that users can start from scratch if
+	 * they want.
+	 *
+	 * @access protected
+	 * @return array|void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _reset_to_default_template()
+	{
+		$templates    = [];
+		$GRP_ID       = $this->request->getRequestParam('GRP_ID', 0, 'int');
+		$messenger    = $this->request->getRequestParam('msgr');
+		$message_type = $this->request->getRequestParam('mt');
+		// we need to make sure we've got the info we need.
+		if (! ($GRP_ID && $messenger && $message_type)) {
+			EE_Error::add_error(
+				esc_html__(
+					'In order to reset the template to its default we require the messenger, message type, and message template GRP_ID to know what is being reset.  At least one of these is missing.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+
+		// all templates will be reset to whatever the defaults are
+		// for the global template matching the messenger and message type.
+		$success = ! empty($GRP_ID);
+
+		if ($success) {
+			// let's first determine if the incoming template is a global template,
+			// if it isn't then we need to get the global template matching messenger and message type.
+			// $MTPG = $this->getMtgModel()->get_one_by_ID( $GRP_ID );
+
+
+			// note this is ONLY deleting the template fields (Message Template rows) NOT the message template group.
+			$success = $this->_delete_mtp_permanently($GRP_ID, false);
+
+			if ($success) {
+				// if successfully deleted, lets generate the new ones.
+				// Note. We set GLOBAL to true, because resets on ANY template
+				// will use the related global template defaults for regeneration.
+				// This means that if a custom template is reset it resets to whatever the related global template is.
+				// HOWEVER, we DO keep the template pack and template variation set
+				// for the current custom template when resetting.
+				$templates = $this->_generate_new_templates($messenger, $message_type, $GRP_ID, true);
+			}
+		}
+
+		// any error messages?
+		if (! $success) {
+			EE_Error::add_error(
+				esc_html__(
+					'Something went wrong with deleting existing templates. Unable to reset to default',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+
+		// all good, let's add a success message!
+		if ($success && ! empty($templates)) {
+			// the info for the template we generated is the first element in the returned array
+			EE_Error::overwrite_success();
+			EE_Error::add_success(esc_html__('Templates have been reset to defaults.', 'event_espresso'));
+		}
+
+
+		$query_args = [
+			'id'      => isset($templates['GRP_ID']) ? $templates['GRP_ID'] : null,
+			'context' => isset($templates['MTP_context']) ? $templates['MTP_context'] : null,
+			'action'  => isset($templates['GRP_ID']) ? 'edit_message_template' : 'global_mtps',
+		];
+
+		// if called via ajax then we return query args otherwise redirect
+		if ($this->request->isAjax()) {
+			return $query_args;
+		}
+		$this->_redirect_after_action(false, '', '', $query_args, true);
+	}
+
+
+	/**
+	 * Retrieve and set the message preview for display.
+	 *
+	 * @param bool $send if TRUE then we are doing an actual TEST send with the results of the preview.
+	 * @return string
+	 * @throws ReflectionException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function _preview_message($send = false)
+	{
+		// first make sure we've got the necessary parameters
+		$GRP_ID = $this->request->getRequestParam('GRP_ID', 0, 'int');
+		if (! ($GRP_ID && $this->_active_messenger_name && $this->_active_message_type_name)) {
+			EE_Error::add_error(
+				esc_html__('Missing necessary parameters for displaying preview', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+
+		$context = $this->request->getRequestParam('context');
+		// get the preview!
+		$preview = EED_Messages::preview_message(
+			$this->_active_message_type_name,
+			$context,
+			$this->_active_messenger_name,
+			$send
+		);
+
+		if ($send) {
+			return $preview;
+		}
+
+		// if we have an evt_id set on the request, use it.
+		$EVT_ID = $this->request->getRequestParam('evt_id', 0, 'int');
+
+		// let's add a button to go back to the edit view
+		$query_args             = [
+			'id'      => $GRP_ID,
+			'evt_id'  => $EVT_ID,
+			'context' => $context,
+			'action'  => 'edit_message_template',
+		];
+		$go_back_url            = parent::add_query_args_and_nonce($query_args, $this->_admin_base_url);
+		$preview_button         = '<a href="'
+								  . $go_back_url
+								  . '" class="button--secondary messages-preview-go-back-button">'
+								  . esc_html__('Go Back to Edit', 'event_espresso')
+								  . '</a>';
+		$message_types          = $this->get_installed_message_types();
+		$active_messenger       = $this->_message_resource_manager->get_active_messenger($this->_active_messenger_name);
+		$active_messenger_label = $active_messenger instanceof EE_messenger
+			? ucwords($active_messenger->label['singular'])
+			: esc_html__('Unknown Messenger', 'event_espresso');
+		// let's provide a helpful title for context
+		$preview_title = sprintf(
+			esc_html__('Viewing Preview for %s %s Message Template', 'event_espresso'),
+			$active_messenger_label,
+			ucwords($message_types[ $this->_active_message_type_name ]->label['singular'])
+		);
+		if (empty($preview)) {
+			$this->noEventsErrorMessage();
+		}
+		// setup display of preview.
+		$this->_admin_page_title                    = $preview_title;
+		$this->_template_args['admin_page_title']   = $preview_title;
+		$this->_template_args['admin_page_content'] = $preview_button . '<br />' . $preview;
+		$this->_template_args['data']['force_json'] = true;
+
+		return '';
+	}
+
+
+	/**
+	 * Used to set an error if there are no events available for generating a preview/test send.
+	 *
+	 * @param bool $test_send Whether the error should be generated for the context of a test send.
+	 */
+	protected function noEventsErrorMessage($test_send = false)
+	{
+		$events_url = parent::add_query_args_and_nonce(
+			[
+				'action' => 'default',
+				'page'   => 'espresso_events',
+			],
+			admin_url('admin.php')
+		);
+		$message    = $test_send
+			? esc_html__(
+				'A test message could not be sent for this message template because there are no events created yet. The preview system uses actual events for generating the test message. %1$sGo see your events%2$s!',
+				'event_espresso'
+			)
+			: esc_html__(
+				'There is no preview for this message template available because there are no events created yet. The preview system uses actual events for generating the preview. %1$sGo see your events%2$s!',
+				'event_espresso'
+			);
+
+		EE_Error::add_attention(
+			sprintf(
+				$message,
+				"<a href='{$events_url}'>",
+				'</a>'
+			)
+		);
+	}
+
+
+	/**
+	 * The initial _preview_message is on a no headers route.  It will optionally call this if necessary otherwise it
+	 * gets called automatically.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @since 4.5.0
+	 *
+	 */
+	protected function _display_preview_message()
+	{
+		$this->display_admin_page_with_no_sidebar();
+	}
+
+
+	/**
+	 * registers metaboxes that should show up on the "edit_message_template" page
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _register_edit_meta_boxes()
+	{
+		$this->addMetaBox(
+			'mtp_valid_shortcodes',
+			esc_html__('Valid Shortcodes', 'event_espresso'),
+			[$this, 'shortcode_meta_box'],
+			$this->_current_screen->id,
+			'side'
+		);
+		$this->addMetaBox(
+			'mtp_extra_actions',
+			esc_html__('Extra Actions', 'event_espresso'),
+			[$this, 'extra_actions_meta_box'],
+			$this->_current_screen->id,
+			'side',
+			'high'
+		);
+		$this->addMetaBox(
+			'mtp_templates',
+			esc_html__('Template Styles', 'event_espresso'),
+			[$this, 'template_pack_meta_box'],
+			$this->_current_screen->id,
+			'side',
+			'high'
+		);
+	}
+
+
+	/**
+	 * metabox content for all template pack and variation selection.
+	 *
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @since 4.5.0
+	 */
+	public function template_pack_meta_box()
+	{
+		$this->_set_message_template_group();
+
+		$tp_collection = EEH_MSG_Template::get_template_pack_collection();
+
+		$tp_select_values = [];
+
+		foreach ($tp_collection as $tp) {
+			// only include template packs that support this messenger and message type!
+			$supports = $tp->get_supports();
+			if (
+				! isset($supports[ $this->_message_template_group->messenger() ])
+				|| ! in_array(
+					$this->_message_template_group->message_type(),
+					$supports[ $this->_message_template_group->messenger() ],
+					true
+				)
+			) {
+				// not supported
+				continue;
+			}
+
+			$tp_select_values[] = [
+				'text' => $tp->label,
+				'id'   => $tp->dbref,
+			];
+		}
+
+		// if empty $tp_select_values then we make sure default is set because EVERY message type should be supported by
+		// the default template pack.  This still allows for the odd template pack to override.
+		if (empty($tp_select_values)) {
+			$tp_select_values[] = [
+				'text' => esc_html__('Default', 'event_espresso'),
+				'id'   => 'default',
+			];
+		}
+
+		// setup variation select values for the currently selected template.
+		$variations               = $this->_message_template_group->get_template_pack()->get_variations(
+			$this->_message_template_group->messenger(),
+			$this->_message_template_group->message_type()
+		);
+		$variations_select_values = [];
+		foreach ($variations as $variation => $label) {
+			$variations_select_values[] = [
+				'text' => $label,
+				'id'   => $variation,
+			];
+		}
+
+		$template_pack_labels = $this->_message_template_group->messenger_obj()->get_supports_labels();
+
+		$template_args['template_packs_selector']        = EEH_Form_Fields::select_input(
+			'MTP_template_pack',
+			$tp_select_values,
+			$this->_message_template_group->get_template_pack_name()
+		);
+		$template_args['variations_selector']            = EEH_Form_Fields::select_input(
+			'MTP_template_variation',
+			$variations_select_values,
+			$this->_message_template_group->get_template_pack_variation()
+		);
+		$template_args['template_pack_label']            = $template_pack_labels->template_pack;
+		$template_args['template_variation_label']       = $template_pack_labels->template_variation;
+		$template_args['template_pack_description']      = $template_pack_labels->template_pack_description;
+		$template_args['template_variation_description'] = $template_pack_labels->template_variation_description;
+
+		$template = EE_MSG_TEMPLATE_PATH . 'template_pack_and_variations_metabox.template.php';
+
+		EEH_Template::display_template($template, $template_args);
+	}
+
+
+	/**
+	 * This meta box holds any extra actions related to Message Templates
+	 * For now, this includes Resetting templates to defaults and sending a test email.
+	 *
+	 * @access  public
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function extra_actions_meta_box()
+	{
+		$template_form_fields = [];
+
+		$extra_args = [
+			'msgr'   => $this->_message_template_group->messenger(),
+			'mt'     => $this->_message_template_group->message_type(),
+			'GRP_ID' => $this->_message_template_group->GRP_ID(),
+		];
+		// first we need to see if there are any fields
+		$fields = $this->_message_template_group->messenger_obj()->get_test_settings_fields();
+
+		if (! empty($fields)) {
+			// yup there be fields
+			foreach ($fields as $field => $config) {
+				$field_id = $this->_message_template_group->messenger() . '_' . $field;
+				$existing = $this->_message_template_group->messenger_obj()->get_existing_test_settings();
+				$default  = isset($config['default']) ? $config['default'] : '';
+				$default  = isset($config['value']) ? $config['value'] : $default;
+
+				// if type is hidden and the value is empty
+				// something may have gone wrong so let's correct with the defaults
+				$fix                = $config['input'] === 'hidden'
+									  && isset($existing[ $field ])
+									  && empty($existing[ $field ])
+					? $default
+					: '';
+				$existing[ $field ] = isset($existing[ $field ]) && empty($fix)
+					? $existing[ $field ]
+					: $fix;
+
+				$template_form_fields[ $field_id ] = [
+					'name'       => 'test_settings_fld[' . $field . ']',
+					'label'      => $config['label'],
+					'input'      => $config['input'],
+					'type'       => $config['type'],
+					'required'   => $config['required'],
+					'validation' => $config['validation'],
+					'value'      => isset($existing[ $field ]) ? $existing[ $field ] : $default,
+					'css_class'  => $config['css_class'],
+					'options'    => isset($config['options']) ? $config['options'] : [],
+					'default'    => $default,
+					'format'     => $config['format'],
+				];
+			}
+		}
+
+		$test_settings_html = ! empty($template_form_fields)
+			? $this->_generate_admin_form_fields($template_form_fields, 'string', 'ee_tst_settings_flds')
+			: '';
+
+		// print out $test_settings_fields
+		if (! empty($test_settings_html)) {
+			$test_settings_html .= '<input type="submit" class="button--primary mtp-test-button alignright" ';
+			$test_settings_html .= 'name="test_button" value="';
+			$test_settings_html .= esc_html__('Test Send', 'event_espresso');
+			$test_settings_html .= '" /><div style="clear:both"></div>';
+		}
+
+		// and button
+		$test_settings_html .= '<div class="publishing-action alignright resetbutton">';
+		$test_settings_html .= '<p>';
+		$test_settings_html .= esc_html__('Need to reset this message type and start over?', 'event_espresso');
+		$test_settings_html .= '</p>';
+		$test_settings_html .= $this->get_action_link_or_button(
+			'reset_to_default',
+			'reset',
+			$extra_args,
+			'button--primary reset-default-button'
+		);
+		$test_settings_html .= '</div><div style="clear:both"></div>';
+		echo wp_kses($test_settings_html, AllowedTags::getWithFormTags());
+	}
+
+
+	/**
+	 * This returns the shortcode selector skeleton for a given context and field.
+	 *
+	 * @param string $field           The name of the field retrieving shortcodes for.
+	 * @param string $linked_input_id The css id of the input that the shortcodes get added to.
+	 * @return string
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @since 4.9.rc.000
+	 */
+	protected function _get_shortcode_selector($field, $linked_input_id)
+	{
+		$template_args = [
+			'shortcodes'      => $this->_get_shortcodes([$field]),
+			'fieldname'       => $field,
+			'linked_input_id' => $linked_input_id,
+		];
+
+		return EEH_Template::display_template(
+			EE_MSG_TEMPLATE_PATH . 'shortcode_selector_skeleton.template.php',
+			$template_args,
+			true
+		);
+	}
+
+
+	/**
+	 * This just takes care of returning the meta box content for shortcodes (only used on the edit message template
+	 * page)
+	 *
+	 * @access public
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function shortcode_meta_box()
+	{
+		$shortcodes = $this->_get_shortcodes([], false);
+		// just make sure the shortcodes property is set
+		// $messenger = $this->_message_template_group->messenger_obj();
+		// now let's set the content depending on the status of the shortcodes array
+		if (empty($shortcodes)) {
+			echo '<p>' . esc_html__('There are no valid shortcodes available', 'event_espresso') . '</p>';
+			return;
+		}
+		?>
         <div style="float:right; margin-top:10px">
             <?php echo wp_kses($this->_get_help_tab_link('message_template_shortcodes'), AllowedTags::getAllowedTags());
-            ?>
+			?>
         </div>
         <p class="small-text">
             <?php printf(
-                esc_html__(
-                    'You can view the shortcodes usable in your template by clicking the %s icon next to each field.',
-                    'event_espresso'
-                ),
-                '<span class="dashicons dashicons-shortcode"></span>'
-            ); ?>
+				esc_html__(
+					'You can view the shortcodes usable in your template by clicking the %s icon next to each field.',
+					'event_espresso'
+				),
+				'<span class="dashicons dashicons-shortcode"></span>'
+			); ?>
         </p>
         <?php
-    }
-
-
-    /**
-     * used to set the $_shortcodes property for when its needed elsewhere.
-     *
-     * @access protected
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _set_shortcodes()
-    {
-
-        // no need to run this if the property is already set
-        if (! empty($this->_shortcodes)) {
-            return;
-        }
-
-        $this->_shortcodes = $this->_get_shortcodes();
-    }
-
-
-    /**
-     * gets all shortcodes for a given template group. (typically used by _set_shortcodes to set the $_shortcodes
-     * property)
-     *
-     * @access  protected
-     * @param array   $fields  include an array of specific field names that you want to be used to get the shortcodes
-     *                         for. Defaults to all (for the given context)
-     * @param boolean $merged  Whether to merge all the shortcodes into one list of unique shortcodes
-     * @return array Shortcodes indexed by fieldname and the an array of shortcode/label pairs OR if merged is
-     *                         true just an array of shortcode/label pairs.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _get_shortcodes($fields = [], $merged = true)
-    {
-        $this->_set_message_template_group();
-
-        // we need the messenger and message template to retrieve the valid shortcodes array.
-        $GRP_ID = $this->request->getRequestParam('id', 0, 'int');
-        if (empty($GRP_ID)) {
-            return [];
-        }
-        $context = $this->request->getRequestParam(
-            'messenger',
-            key($this->_message_template_group->contexts_config())
-        );
-        return $this->_message_template_group->get_shortcodes($context, $fields, $merged);
-    }
-
-
-    /**
-     * This sets the _message_template property (containing the called message_template object)
-     *
-     * @access protected
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _set_message_template_group()
-    {
-        // get out if this is already set.
-        if (! empty($this->_message_template_group)) {
-            return;
-        }
-
-        $GRP_ID = $this->request->getRequestParam('GRP_ID', 0, 'int');
-        $GRP_ID = $this->request->getRequestParam('id', $GRP_ID, 'int');
-
-        // let's get the message templates
-        $this->_message_template_group = ! empty($GRP_ID)
-            ? $this->getMtgModel()->get_one_by_ID($GRP_ID)
-            : $this->getMtgModel()->create_default_object();
-
-        $this->_template_pack = $this->_message_template_group->get_template_pack();
-        $this->_variation     = $this->_message_template_group->get_template_pack_variation();
-    }
-
-
-    /**
-     * sets up a context switcher for edit forms
-     *
-     * @access  protected
-     * @param EE_Message_Template_Group $template_group_object the template group object being displayed on the form
-     * @param array                     $args                  various things the context switcher needs.
-     * @throws EE_Error
-     */
-    protected function _set_context_switcher(EE_Message_Template_Group $template_group_object, $args)
-    {
-        $context_details = $template_group_object->contexts_config();
-        $context_label   = $template_group_object->context_label();
-        ob_start();
-        ?>
+	}
+
+
+	/**
+	 * used to set the $_shortcodes property for when its needed elsewhere.
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _set_shortcodes()
+	{
+
+		// no need to run this if the property is already set
+		if (! empty($this->_shortcodes)) {
+			return;
+		}
+
+		$this->_shortcodes = $this->_get_shortcodes();
+	}
+
+
+	/**
+	 * gets all shortcodes for a given template group. (typically used by _set_shortcodes to set the $_shortcodes
+	 * property)
+	 *
+	 * @access  protected
+	 * @param array   $fields  include an array of specific field names that you want to be used to get the shortcodes
+	 *                         for. Defaults to all (for the given context)
+	 * @param boolean $merged  Whether to merge all the shortcodes into one list of unique shortcodes
+	 * @return array Shortcodes indexed by fieldname and the an array of shortcode/label pairs OR if merged is
+	 *                         true just an array of shortcode/label pairs.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _get_shortcodes($fields = [], $merged = true)
+	{
+		$this->_set_message_template_group();
+
+		// we need the messenger and message template to retrieve the valid shortcodes array.
+		$GRP_ID = $this->request->getRequestParam('id', 0, 'int');
+		if (empty($GRP_ID)) {
+			return [];
+		}
+		$context = $this->request->getRequestParam(
+			'messenger',
+			key($this->_message_template_group->contexts_config())
+		);
+		return $this->_message_template_group->get_shortcodes($context, $fields, $merged);
+	}
+
+
+	/**
+	 * This sets the _message_template property (containing the called message_template object)
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _set_message_template_group()
+	{
+		// get out if this is already set.
+		if (! empty($this->_message_template_group)) {
+			return;
+		}
+
+		$GRP_ID = $this->request->getRequestParam('GRP_ID', 0, 'int');
+		$GRP_ID = $this->request->getRequestParam('id', $GRP_ID, 'int');
+
+		// let's get the message templates
+		$this->_message_template_group = ! empty($GRP_ID)
+			? $this->getMtgModel()->get_one_by_ID($GRP_ID)
+			: $this->getMtgModel()->create_default_object();
+
+		$this->_template_pack = $this->_message_template_group->get_template_pack();
+		$this->_variation     = $this->_message_template_group->get_template_pack_variation();
+	}
+
+
+	/**
+	 * sets up a context switcher for edit forms
+	 *
+	 * @access  protected
+	 * @param EE_Message_Template_Group $template_group_object the template group object being displayed on the form
+	 * @param array                     $args                  various things the context switcher needs.
+	 * @throws EE_Error
+	 */
+	protected function _set_context_switcher(EE_Message_Template_Group $template_group_object, $args)
+	{
+		$context_details = $template_group_object->contexts_config();
+		$context_label   = $template_group_object->context_label();
+		ob_start();
+		?>
         <div class="ee-msg-switcher-container">
             <form method="get" action="<?php echo esc_url_raw(EE_MSG_ADMIN_URL); ?>" id="ee-msg-context-switcher-frm">
                 <?php
-                foreach ($args as $name => $value) {
-                    if ($name === 'context' || empty($value) || $name === 'extra') {
-                        continue;
-                    }
-                    ?>
+				foreach ($args as $name => $value) {
+					if ($name === 'context' || empty($value) || $name === 'extra') {
+						continue;
+					}
+					?>
                     <input type="hidden"
                            name="<?php echo esc_attr($name); ?>"
                            value="<?php echo esc_attr($value); ?>"
                     />
                     <?php
-                }
-                // setup nonce_url
-                wp_nonce_field($args['action'] . '_nonce', $args['action'] . '_nonce', false);
-                $id = 'ee-' . sanitize_key($context_label['label']) . '-select';
-                ?>
+				}
+				// setup nonce_url
+				wp_nonce_field($args['action'] . '_nonce', $args['action'] . '_nonce', false);
+				$id = 'ee-' . sanitize_key($context_label['label']) . '-select';
+				?>
                 <label for='<?php echo esc_attr($id); ?>' class='screen-reader-text'>
                     <?php esc_html_e('message context options', 'event_espresso'); ?>
                 </label>
                 <select id="<?php echo esc_attr($id); ?>" name="context">
                     <?php
-                    $context_templates = $template_group_object->context_templates();
-                    if (is_array($context_templates)) :
-                        foreach ($context_templates as $context => $template_fields) :
-                            $checked = ($context === $args['context']) ? 'selected' : '';
-                            ?>
+					$context_templates = $template_group_object->context_templates();
+					if (is_array($context_templates)) :
+						foreach ($context_templates as $context => $template_fields) :
+							$checked = ($context === $args['context']) ? 'selected' : '';
+							?>
                             <option value="<?php echo esc_attr($context); ?>" <?php echo esc_attr($checked); ?>>
                                 <?php echo esc_html($context_details[ $context ]['label']); ?>
                             </option>
                         <?php endforeach;
-                    endif; ?>
+					endif; ?>
                 </select>
                 <?php $button_text = sprintf(
-                    esc_html__('Switch %s', 'event_espresso'),
-                    ucwords($context_label['label'])
-                ); ?>
+					esc_html__('Switch %s', 'event_espresso'),
+					ucwords($context_label['label'])
+				); ?>
                 <input class='button--secondary'
                        id="submit-msg-context-switcher-sbmt"
                        type="submit"
@@ -2710,1996 +2710,1996 @@ 
             <?php echo wp_kses($args['extra'], AllowedTags::getWithFormTags()); ?>
         </div> <!-- end .ee-msg-switcher-container -->
         <?php $this->_context_switcher = ob_get_clean();
-    }
-
-
-    /**
-     * @param bool $new
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _insert_or_update_message_template($new = false)
-    {
-        $form_data    = $this->getMessageTemplateFormData();
-        $GRP_ID       = $form_data['GRP_ID'];
-        $messenger    = $form_data['MTP_messenger'];
-        $message_type = $form_data['MTP_message_type'];
-        $context      = $form_data['MTP_context'];
-
-        // if this is "new" then we need to generate the default contexts
-        // for the selected messenger/message_type for user to edit.
-        [$success, $query_args] = $new
-            ? $this->generateNewTemplates($GRP_ID, $messenger, $message_type)
-            : $this->updateExistingTemplates($GRP_ID, $messenger, $message_type, $context, $form_data);
-
-        $success     = $success ? 1 : 0;
-        $action_desc = $new ? 'created' : 'updated';
-        $item_desc   = $this->generateUpdateDescription($messenger, $message_type, $context);
-        $override    = $this->performTestSendAfterUpdate($messenger, $message_type, $context);
-
-        $this->_redirect_after_action($success, $item_desc, $action_desc, $query_args, $override);
-    }
-
-
-    /**
-     * retrieve and sanitize form data
-     *
-     * @return array
-     * @since 4.10.29.p
-     */
-    protected function getMessageTemplateFormData()
-    {
-        return [
-            'GRP_ID'           => $this->request->getRequestParam('GRP_ID', 0, 'int'),
-            'MTP_context'      => strtolower($this->request->getRequestParam('MTP_context', '')),
-            'MTP_messenger'    => strtolower($this->request->getRequestParam('MTP_messenger', '')),
-            'MTP_message_type' => strtolower($this->request->getRequestParam('MTP_message_type', '')),
-            'MTP_user_id'      => $this->request->getRequestParam('MTP_user_id', 0, 'int'),
-            'MTP_is_global'    => $this->request->getRequestParam('MTP_is_global', 0, 'int'),
-            'MTP_is_override'  => $this->request->getRequestParam('MTP_is_override', 0, 'int'),
-            'MTP_deleted'      => $this->request->getRequestParam('MTP_deleted', 0, 'int'),
-            'MTP_is_active'    => $this->request->getRequestParam('MTP_is_active', 0, 'int'),
-        ];
-    }
-
-
-    /**
-     * @param int    $GRP_ID
-     * @param string $messenger
-     * @param string $message_type
-     * @return array no return on AJAX requests
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since 4.10.29.p
-     */
-    private function generateNewTemplates($GRP_ID, $messenger, $message_type)
-    {
-        $new_templates = $this->_generate_new_templates($messenger, [$message_type], $GRP_ID);
-        $success       = ! empty($new_templates);
-
-        // we return things differently if doing ajax
-        if ($this->request->isAjax()) {
-            $this->_template_args['success'] = $success;
-            $this->_template_args['error']   = ! $success;
-            $this->_template_args['content'] = '';
-            $this->_template_args['data']    = [
-                'grpID'        => $new_templates['GRP_ID'],
-                'templateName' => $new_templates['template_name'],
-            ];
-            if ($success) {
-                EE_Error::overwrite_success();
-                EE_Error::add_success(
-                    esc_html__(
-                        'The new template has been created and automatically selected for this event.  You can edit the new template by clicking the edit button.  Note before this template is assigned to this event, the event must be saved.',
-                        'event_espresso'
-                    )
-                );
-            }
-            $this->_return_json();
-        }
-        return [
-            $success,
-            // 'query_args'
-            [
-                'id'      => $new_templates['GRP_ID'],
-                'context' => $new_templates['MTP_context'],
-                'action'  => 'edit_message_template',
-            ],
-        ];
-    }
-
-
-    /**
-     * @param int    $GRP_ID
-     * @param string $messenger
-     * @param string $message_type
-     * @param string $context
-     * @param array  $form_data
-     * @return array
-     * @throws EE_Error
-     * @since 4.10.29.p
-     */
-    private function updateExistingTemplates(
-        $GRP_ID,
-        $messenger,
-        $message_type,
-        $context,
-        array $form_data
-    ) {
-        $success         = false;
-        $template_fields = $this->getTemplateFields();
-        if ($template_fields) {
-            // if field data is valid, then success will be true
-            $success = $this->validateTemplateFields(
-                $messenger,
-                $message_type,
-                $context,
-                $template_fields
-            );
-            if ($success) {
-                $field_data = [];
-                foreach ($template_fields as $template_field => $content) {
-                    // combine top-level form data with content for this field
-                    $field_data = $this->getTemplateFieldFormData($content, $form_data);
-                    $success    = $this->updateMessageTemplates($template_field, $field_data) ? $success : false;
-                }
-                // we can use the last set_column_values for the MTPG update
-                // (because its the same for all of these specific MTPs)
-                $success = $this->updateMessageTemplateGroup($field_data) ? $success : false;
-            }
-        }
-
-        return [
-            $success,
-            // 'query_args'
-            [
-                'id'      => $GRP_ID,
-                'context' => $context,
-                'action'  => 'edit_message_template',
-            ],
-        ];
-    }
-
-
-    /**
-     * @return array
-     * @since 4.10.29.p
-     */
-    private function getTemplateFields()
-    {
-        $template_fields = $this->request->getRequestParam('MTP_template_fields', null, 'html', true);
-        if (empty($template_fields)) {
-            EE_Error::add_error(
-                esc_html__(
-                    'There was a problem saving the template fields from the form because I didn\'t receive any actual template field data.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return null;
-        }
-        // messages content is expected to be escaped
-        return EEH_Array::addSlashesRecursively($template_fields);
-    }
-
-
-    /**
-     * @param string $messenger
-     * @param string $message_type
-     * @param string $context
-     * @param array  $template_fields
-     * @return bool
-     * @throws EE_Error
-     * @since   4.10.29.p
-     */
-    private function validateTemplateFields(
-        $messenger,
-        $message_type,
-        $context,
-        array $template_fields
-    ) {
-        // first validate all fields!
-        // this filter allows client code to add its own validation to the template fields as well.
-        // returning an empty array means everything passed validation.
-        // errors in validation should be represented in an array with the following shape:
-        // array(
-        //   'fieldname' => array(
-        //          'msg' => 'error message'
-        //          'value' => 'value for field producing error'
-        // )
-        $custom_validation = (array) apply_filters(
-            'FHEE__Messages_Admin_Page___insert_or_update_message_template__validates',
-            [],
-            $template_fields,
-            $context,
-            $messenger,
-            $message_type
-        );
-
-        $system_validation = $this->getMtgModel()->validate(
-            $template_fields,
-            $context,
-            $messenger,
-            $message_type
-        );
-
-        $system_validation = ! is_array($system_validation) && $system_validation ? [] : $system_validation;
-        $validates         = array_merge($custom_validation, $system_validation);
-
-        // if $validate returned error messages (i.e. is_array()) then we need to process them and setup an
-        // appropriate response. HMM, dang this isn't correct, $validates will ALWAYS be an array.
-        //  WE need to make sure there is no actual error messages in validates.
-        if (empty($validates)) {
-            return true;
-        }
-
-        // add the transient so when the form loads we know which fields to highlight
-        $this->_add_transient('edit_message_template', $validates);
-        // setup notices
-        foreach ($validates as $error) {
-            if (isset($error['msg'])) {
-                EE_Error::add_error($error['msg'], __FILE__, __FUNCTION__, __LINE__);
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * @param array $field_data
-     * @param array $form_data
-     * @return array
-     * @since   4.10.29.p
-     */
-    private function getTemplateFieldFormData(array $field_data, array $form_data)
-    {
-        return $form_data + [
-                'MTP_ID'             => $field_data['MTP_ID'],
-                'MTP_template_field' => $field_data['name'],
-                // if they aren't allowed to use all JS, restrict them to standard allowed post tags
-                'MTP_content'        => ! current_user_can('unfiltered_html')
-                    ? $this->sanitizeMessageTemplateContent($field_data['content'])
-                    : $field_data['content'],
-            ];
-    }
-
-
-    /**
-     * @param string $template_field
-     * @param array  $form_data
-     * @return bool
-     * @throws EE_Error
-     * @since 4.10.29.p
-     */
-    private function updateMessageTemplates($template_field, array $form_data)
-    {
-        $MTP_ID                  = $form_data['MTP_ID'];
-        $message_template_fields = [
-            'GRP_ID'             => $form_data['GRP_ID'],
-            'MTP_template_field' => $form_data['MTP_template_field'],
-            'MTP_context'        => $form_data['MTP_context'],
-            'MTP_content'        => $form_data['MTP_content'],
-        ];
-
-        $hasMtpID = ! empty($MTP_ID);
-        // if we have a MTP_ID for this field then update it, otherwise insert.
-        // this has already been through the template field validator and sanitized, so it will be
-        // safe to insert this field.  Why insert?  This typically happens when we introduce a new
-        // message template field in a messenger/message type and existing users don't have the
-        // default setup for it.
-        // @link https://events.codebasehq.com/projects/event-espresso/tickets/9465
-        $updated = $hasMtpID
-            ? $this->getMtpModel()->update($message_template_fields, [['MTP_ID' => $MTP_ID]])
-            : $this->getMtpModel()->insert($message_template_fields);
-
-        $insert_failed = ! $hasMtpID && ! $updated;
-        // updates will return 0 if the field was not changed (ie: no changes = nothing actually updated)
-        // but we won't consider that a problem, but if it returns false, then something went BOOM!
-        $update_failed = $hasMtpID && $updated === false;
-
-        if ($insert_failed || $update_failed) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__('%s field was NOT updated for some reason', 'event_espresso'),
-                    $template_field
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * @param array $form_data
-     * @return bool
-     * @throws EE_Error
-     * @since 4.10.29.p
-     */
-    private function updateMessageTemplateGroup(array $form_data)
-    {
-        $GRP_ID  = $form_data['GRP_ID'];
-        $updated = $this->getMtgModel()->update(
-        // fields and values
-            [
-                'MTP_user_id'      => $form_data['MTP_user_id'],
-                'MTP_messenger'    => $form_data['MTP_messenger'],
-                'MTP_message_type' => $form_data['MTP_message_type'],
-                'MTP_is_global'    => $form_data['MTP_is_global'],
-                'MTP_is_override'  => $form_data['MTP_is_override'],
-                'MTP_deleted'      => $form_data['MTP_deleted'],
-                'MTP_is_active'    => $form_data['MTP_is_active'],
-                'MTP_name'         => $this->request->getRequestParam('ee_msg_non_global_fields[MTP_name]', ''),
-                'MTP_description'  => $this->request->getRequestParam(
-                    'ee_msg_non_global_fields[MTP_description]',
-                    ''
-                ),
-            ],
-            // where
-            [['GRP_ID' => $GRP_ID]]
-        );
-
-        if ($updated === false) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'The Message Template Group (%d) was NOT updated for some reason',
-                        'event_espresso'
-                    ),
-                    $form_data['GRP_ID']
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        // k now we need to ensure the template_pack and template_variation fields are set.
-        $template_pack      = $this->request->getRequestParam('MTP_template_pack', 'default');
-        $template_variation = $this->request->getRequestParam('MTP_template_variation', 'default');
-
-        $message_template_group = $this->getMtgModel()->get_one_by_ID($GRP_ID);
-        if ($message_template_group instanceof EE_Message_Template_Group) {
-            $message_template_group->set_template_pack_name($template_pack);
-            $message_template_group->set_template_pack_variation($template_variation);
-        }
-        return true;
-    }
-
-
-    /**
-     * recursively runs wp_kses() on message template content in a model safe manner
-     *
-     * @param array|string $content
-     * @return array|string
-     * @since   4.10.29.p
-     */
-    private function sanitizeMessageTemplateContent($content)
-    {
-        if (is_array($content)) {
-            foreach ($content as $key => $value) {
-                $content[ $key ] = $this->sanitizeMessageTemplateContent($value);
-            }
-            return $content;
-        }
-        // remove slashes so wp_kses() works properly
-        // wp_kses_stripslashes() only removes slashes from double-quotes,
-        // so attributes using single quotes always appear invalid.
-        $content = stripslashes($content);
-        $content = wp_kses($content, wp_kses_allowed_html('post'));
-        // But currently the models expect slashed data, so after wp_kses()
-        // runs we need to re-slash the data. Sheesh.
-        // See https://events.codebasehq.com/projects/event-espresso/tickets/11211#update-47321587
-        return addslashes($content);
-    }
-
-
-    /**
-     * @param string $messenger
-     * @param string $message_type
-     * @param string $context
-     * @return string
-     * @since 4.10.29.p
-     */
-    private function generateUpdateDescription($messenger, $message_type, $context)
-    {
-        // need the message type and messenger objects to be able to use the labels for the notices
-        $messenger_object = $this->_message_resource_manager->get_messenger($messenger);
-        $messenger_label  = $messenger_object instanceof EE_messenger
-            ? ucwords($messenger_object->label['singular'])
-            : '';
-
-        $message_type_object = $this->_message_resource_manager->get_message_type($message_type);
-        $message_type_label  = $message_type_object instanceof EE_message_type
-            ? ucwords($message_type_object->label['singular'])
-            : '';
-
-        $context   = ucwords(str_replace('_', ' ', $context));
-        $item_desc = $messenger_label && $message_type_label
-            ? $messenger_label . ' ' . $message_type_label . ' ' . $context . ' '
-            : '';
-        $item_desc .= 'Message Template';
-        return $item_desc;
-    }
-
-
-    /**
-     * @param string $messenger
-     * @param string $message_type
-     * @param string $context
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since 4.10.29.p
-     */
-    private function performTestSendAfterUpdate($messenger, $message_type, $context)
-    {
-        // was a test send triggered?
-        if ($this->request->requestParamIsSet('test_button')) {
-            EE_Error::overwrite_success();
-            $this->_do_test_send($context, $messenger, $message_type);
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * processes a test send request to do an actual messenger delivery test for the given message template being tested
-     *
-     * @param string $context      what context being tested
-     * @param string $messenger    messenger being tested
-     * @param string $message_type message type being tested
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _do_test_send($context, $messenger, $message_type)
-    {
-        // set things up for preview
-        $this->request->setRequestParam('messenger', $messenger);
-        $this->request->setRequestParam('message_type', $message_type);
-        $this->request->setRequestParam('context', $context);
-        $GRP_ID = $this->request->getRequestParam('GRP_ID', 0, 'int');
-        $this->request->setRequestParam('GRP_ID', $GRP_ID);
-
-        $active_messenger  = $this->_message_resource_manager->get_active_messenger($messenger);
-        $test_settings_fld = $this->request->getRequestParam('test_settings_fld', [], 'string', true);
-
-        // let's save any existing fields that might be required by the messenger
-        if (
-            ! empty($test_settings_fld)
-            && $active_messenger instanceof EE_messenger
-            && apply_filters(
-                'FHEE__Messages_Admin_Page__do_test_send__set_existing_test_settings',
-                true,
-                $test_settings_fld,
-                $active_messenger
-            )
-        ) {
-            $active_messenger->set_existing_test_settings($test_settings_fld);
-        }
-
-        /**
-         * Use filter to add additional controls on whether message can send or not
-         */
-        if (
-            apply_filters(
-                'FHEE__Messages_Admin_Page__do_test_send__can_send',
-                true,
-                $context,
-                $this->request->requestParams(),
-                $messenger,
-                $message_type
-            )
-        ) {
-            if (EEM_Event::instance()->count() > 0) {
-                $success = $this->_preview_message(true);
-                if ($success) {
-                    EE_Error::add_success(esc_html__('Test message sent', 'event_espresso'));
-                } else {
-                    EE_Error::add_error(
-                        esc_html__('The test message was not sent', 'event_espresso'),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                }
-            } else {
-                $this->noEventsErrorMessage(true);
-            }
-        }
-    }
-
-
-    /**
-     * _generate_new_templates
-     * This will handle the messenger, message_type selection when "adding a new custom template" for an event and will
-     * automatically create the defaults for the event.  The user would then be redirected to edit the default context
-     * for the event.
-     *
-     *
-     * @param string $messenger      the messenger we are generating templates for
-     * @param array  $message_types  array of message types that the templates are generated for.
-     * @param int    $GRP_ID         If this is a custom template being generated then a GRP_ID needs to be included to
-     *                               indicate the message_template_group being used as the base.
-     *
-     * @param bool   $global
-     *
-     * @return array|bool array of data required for the redirect to the correct edit page or bool if
-     *                               encountering problems.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _generate_new_templates($messenger, $message_types, $GRP_ID = 0, $global = false)
-    {
-        // if no $message_types are given then that's okay... this may be a messenger that just adds shortcodes, so we
-        // just don't generate any templates.
-        if (empty($message_types)) {
-            return [];
-        }
-
-        $templates = EEH_MSG_Template::generate_new_templates($messenger, $message_types, $GRP_ID, $global);
-        return $templates[0];
-    }
-
-
-    /**
-     * [_trash_or_restore_message_template]
-     *
-     * @param boolean $trash  whether to move an item to trash/restore (TRUE) or restore it (FALSE)
-     * @param boolean $all    whether this is going to trash/restore all contexts within a template group (TRUE) OR just
-     *                        an individual context (FALSE).
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _trash_or_restore_message_template($trash = true, $all = false)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-
-        $success = 1;
-
-        // incoming GRP_IDs
-        if ($all) {
-            // Checkboxes
-            $checkboxes = $this->request->getRequestParam('checkbox', [], 'int', true);
-            if (! empty($checkboxes)) {
-                // if array has more than one element then success message should be plural.
-                // todo: what about nonce?
-                $success = count($checkboxes) > 1 ? 2 : 1;
-
-                // cycle through checkboxes
-                while (list($GRP_ID, $value) = each($checkboxes)) {
-                    $trashed_or_restored = $trash
-                        ? $this->getMtgModel()->delete_by_ID($GRP_ID)
-                        : $this->getMtgModel()->restore_by_ID($GRP_ID);
-                    if (! $trashed_or_restored) {
-                        $success = 0;
-                    }
-                }
-            } else {
-                // grab single GRP_ID and handle
-                $GRP_ID = $this->request->getRequestParam('id', 0, 'int');
-                if (! empty($GRP_ID)) {
-                    $trashed_or_restored = $trash
-                        ? $this->getMtgModel()->delete_by_ID($GRP_ID)
-                        : $this->getMtgModel()->restore_by_ID($GRP_ID);
-                    if (! $trashed_or_restored) {
-                        $success = 0;
-                    }
-                } else {
-                    $success = 0;
-                }
-            }
-        }
-
-        $action_desc = $trash
-            ? esc_html__('moved to the trash', 'event_espresso')
-            : esc_html__('restored', 'event_espresso');
-
-        $template_switch = $this->request->getRequestParam('template_switch', false, 'bool');
-        $action_desc     = $template_switch ? esc_html__('switched', 'event_espresso') : $action_desc;
-
-        $item_desc = $all ? _n(
-            'Message Template Group',
-            'Message Template Groups',
-            $success,
-            'event_espresso'
-        ) : _n('Message Template Context', 'Message Template Contexts', $success, 'event_espresso');
-
-        $item_desc = $template_switch
-            ? _n('template', 'templates', $success, 'event_espresso')
-            : $item_desc;
-
-        $this->_redirect_after_action($success, $item_desc, $action_desc, []);
-    }
-
-
-    /**
-     * [_delete_message_template]
-     * NOTE: this handles not only the deletion of the groups but also all the templates belonging to that group.
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _delete_message_template()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-
-        // checkboxes
-        $checkboxes = $this->request->getRequestParam('checkbox', [], 'int', true);
-        if (! empty($checkboxes)) {
-            // if array has more than one element then success message should be plural
-            $success = count($checkboxes) > 1 ? 2 : 1;
-
-            // cycle through bulk action checkboxes
-            while (list($GRP_ID, $value) = each($checkboxes)) {
-                $success = $this->_delete_mtp_permanently($GRP_ID) ? $success : false;
-            }
-        } else {
-            // grab single grp_id and delete
-            $GRP_ID  = $this->request->getRequestParam('id', 0, 'int');
-            $success = $this->_delete_mtp_permanently($GRP_ID);
-        }
-
-        $this->_redirect_after_action($success, 'Message Templates', 'deleted', []);
-    }
-
-
-    /**
-     * helper for permanently deleting a mtP group and all related message_templates
-     *
-     * @param int  $GRP_ID        The group being deleted
-     * @param bool $include_group whether to delete the Message Template Group as well.
-     * @return bool boolean to indicate the success of the deletes or not.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws ReflectionException
-     */
-    private function _delete_mtp_permanently($GRP_ID, $include_group = true)
-    {
-        $success = true;
-        // first let's GET this group
-        $MTG = $this->getMtgModel()->get_one_by_ID($GRP_ID);
-        // then delete permanently all the related Message Templates
-        $deleted = $MTG->delete_related_permanently('Message_Template');
-
-        if ($deleted === 0) {
-            $success = false;
-        }
-
-        // now delete permanently this particular group
-
-        if ($include_group && ! $MTG->delete_permanently()) {
-            $success = false;
-        }
-
-        return $success;
-    }
-
-
-    /**
-     *    _learn_more_about_message_templates_link
-     *
-     * @access protected
-     * @return string
-     */
-    protected function _learn_more_about_message_templates_link()
-    {
-        return '<a class="hidden" style="margin:0 20px; cursor:pointer; font-size:12px;" >'
-               . esc_html__('learn more about how message templates works', 'event_espresso')
-               . '</a>';
-    }
-
-
-    /**
-     * Used for setting up messenger/message type activation.  This loads up the initial view.  The rest is handled by
-     * ajax and other routes.
-     *
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    protected function _settings()
-    {
-        $this->_set_m_mt_settings();
-
-        // let's setup the messenger tabs
-        $this->_template_args['admin_page_header'] = EEH_Tabbed_Content::tab_text_links(
-            $this->_m_mt_settings['messenger_tabs'],
-            'messenger_links',
-            '|',
-            $this->request->getRequestParam('selected_messenger', 'email')
-        );
-
-        $this->_template_args['before_admin_page_content'] = '<div class="ui-widget ui-helper-clearfix">';
-        $this->_template_args['after_admin_page_content']  = '</div><!-- end .ui-widget -->';
-
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * This sets the $_m_mt_settings property for when needed (used on the Messages settings page)
-     *
-     * @access protected
-     * @return void
-     * @throws DomainException
-     */
-    protected function _set_m_mt_settings()
-    {
-        // first if this is already set then lets get out no need to regenerate data.
-        if (! empty($this->_m_mt_settings)) {
-            return;
-        }
-
-        // get all installed messengers and message_types
-        $messengers    = $this->_message_resource_manager->installed_messengers();
-        $message_types = $this->_message_resource_manager->installed_message_types();
-
-
-        // assemble the array for the _tab_text_links helper
-
-        foreach ($messengers as $messenger) {
-            $active = $this->_message_resource_manager->is_messenger_active($messenger->name);
-            $class = 'ee-messenger-' .  sanitize_key($messenger->label['singular']);
-            $this->_m_mt_settings['messenger_tabs'][ $messenger->name ] = [
-                'label' => ucwords($messenger->label['singular']),
-                'class' => $active ? "{$class} messenger-active" : $class,
-                'href'  => $messenger->name,
-                'title' => esc_html__('Modify this Messenger', 'event_espresso'),
-                'slug'  => $messenger->name,
-                'obj'   => $messenger,
-                'icon' => $active
-                    ? '<span class="dashicons dashicons-yes-alt"></span>'
-                    : '<span class="dashicons dashicons-remove"></span>',
-            ];
-
-
-            $message_types_for_messenger = $messenger->get_valid_message_types();
-
-            foreach ($message_types as $message_type) {
-                // first we need to verify that this message type is valid with this messenger. Cause if it isn't then
-                // it shouldn't show in either the inactive OR active metabox.
-                if (! in_array($message_type->name, $message_types_for_messenger, true)) {
-                    continue;
-                }
-
-                $a_or_i = $this->_message_resource_manager->is_message_type_active_for_messenger(
-                    $messenger->name,
-                    $message_type->name
-                )
-                    ? 'active'
-                    : 'inactive';
-
-                $this->_m_mt_settings['message_type_tabs'][ $messenger->name ][ $a_or_i ][ $message_type->name ] = [
-                    'label'    => ucwords($message_type->label['singular']),
-                    'class'    => 'message-type-' . $a_or_i,
-                    'slug_id'  => $message_type->name . '-messagetype-' . $messenger->name,
-                    'mt_nonce' => wp_create_nonce($message_type->name . '_nonce'),
-                    'href'     => 'espresso_' . $message_type->name . '_message_type_settings',
-                    'title'    => $a_or_i === 'active'
-                        ? esc_html__('Drag this message type to the Inactive window to deactivate', 'event_espresso')
-                        : esc_html__('Drag this message type to the messenger to activate', 'event_espresso'),
-                    'content'  => $a_or_i === 'active'
-                        ? $this->_message_type_settings_content($message_type, $messenger, true)
-                        : $this->_message_type_settings_content($message_type, $messenger),
-                    'slug'     => $message_type->name,
-                    'active'   => $a_or_i === 'active',
-                    'obj'      => $message_type,
-                ];
-            }
-        }
-    }
-
-
-    /**
-     * This just prepares the content for the message type settings
-     *
-     * @param EE_message_type $message_type The message type object
-     * @param EE_messenger    $messenger    The messenger object
-     * @param boolean         $active       Whether the message type is active or not
-     * @return string html output for the content
-     * @throws DomainException
-     */
-    protected function _message_type_settings_content($message_type, $messenger, $active = false)
-    {
-        // get message type fields
-        $fields                                         = $message_type->get_admin_settings_fields();
-        $settings_template_args['template_form_fields'] = '';
-
-        if (! empty($fields) && $active) {
-            $existing_settings = $message_type->get_existing_admin_settings($messenger->name);
-            foreach ($fields as $fldname => $fldprops) {
-                $field_id                         = $messenger->name . '-' . $message_type->name . '-' . $fldname;
-                $template_form_field[ $field_id ] = [
-                    'name'       => 'message_type_settings[' . $fldname . ']',
-                    'label'      => $fldprops['label'],
-                    'input'      => $fldprops['field_type'],
-                    'type'       => $fldprops['value_type'],
-                    'required'   => $fldprops['required'],
-                    'validation' => $fldprops['validation'],
-                    'value'      => isset($existing_settings[ $fldname ])
-                        ? $existing_settings[ $fldname ]
-                        : $fldprops['default'],
-                    'options'    => isset($fldprops['options'])
-                        ? $fldprops['options']
-                        : [],
-                    'default'    => isset($existing_settings[ $fldname ])
-                        ? $existing_settings[ $fldname ]
-                        : $fldprops['default'],
-                    'css_class'  => 'no-drag',
-                    'format'     => $fldprops['format'],
-                ];
-            }
-
-
-            $settings_template_args['template_form_fields'] = ! empty($template_form_field)
-                ? $this->_generate_admin_form_fields(
-                    $template_form_field,
-                    'string',
-                    'ee_mt_activate_form'
-                )
-                : '';
-        }
-
-        $settings_template_args['description'] = $message_type->description;
-        // we also need some hidden fields
-        $hidden_fields = [
-            'message_type_settings[messenger]' . $message_type->name    => [
-                'type'  => 'hidden',
-                'value' => $messenger->name,
-            ],
-            'message_type_settings[message_type]' . $message_type->name => [
-                'type'  => 'hidden',
-                'value' => $message_type->name,
-            ],
-            'type' . $message_type->name                                => [
-                'type'  => 'hidden',
-                'value' => 'message_type',
-            ],
-        ];
-
-        $settings_template_args['hidden_fields'] = $this->_generate_admin_form_fields(
-            $hidden_fields,
-            'array'
-        );
-        $settings_template_args['show_form']     = empty($settings_template_args['template_form_fields'])
-            ? ' hidden'
-            : '';
-
-
-        $template = EE_MSG_TEMPLATE_PATH . 'ee_msg_mt_settings_content.template.php';
-        return EEH_Template::display_template($template, $settings_template_args, true);
-    }
-
-
-    /**
-     * Generate all the metaboxes for the message types and register them for the messages settings page.
-     *
-     * @access protected
-     * @return void
-     * @throws DomainException
-     */
-    protected function _messages_settings_metaboxes()
-    {
-        $this->_set_m_mt_settings();
-        $m_boxes         = $mt_boxes = [];
-        $m_template_args = $mt_template_args = [];
-
-        $selected_messenger = $this->request->getRequestParam('selected_messenger', 'email');
-
-        if (isset($this->_m_mt_settings['messenger_tabs'])) {
-            foreach ($this->_m_mt_settings['messenger_tabs'] as $messenger => $tab_array) {
-                $is_messenger_active = $this->_message_resource_manager->is_messenger_active($messenger);
-                $hide_on_message     = $is_messenger_active ? '' : 'hidden';
-                $hide_off_message    = $is_messenger_active ? 'hidden' : '';
-
-                // messenger meta boxes
-                $active         = $selected_messenger === $messenger;
-                $active_mt_tabs = isset($this->_m_mt_settings['message_type_tabs'][ $messenger ]['active'])
-                    ? $this->_m_mt_settings['message_type_tabs'][ $messenger ]['active']
-                    : '';
-
-                $m_boxes[ $messenger . '_a_box' ] = sprintf(
-                    esc_html__('%s Settings', 'event_espresso'),
-                    $tab_array['label']
-                );
-
-                $m_template_args[ $messenger . '_a_box' ] = [
-                    'active_message_types'   => ! empty($active_mt_tabs) ? $this->_get_mt_tabs($active_mt_tabs) : '',
-                    'inactive_message_types' => isset(
-                        $this->_m_mt_settings['message_type_tabs'][ $messenger ]['inactive']
-                    )
-                        ? $this->_get_mt_tabs($this->_m_mt_settings['message_type_tabs'][ $messenger ]['inactive'])
-                        : '',
-                    'content'                => $this->_get_messenger_box_content($tab_array['obj']),
-                    'hidden'                 => $active ? '' : ' hidden',
-                    'hide_on_message'        => $hide_on_message,
-                    'messenger'              => $messenger,
-                    'active'                 => $active,
-                ];
-
-                // message type meta boxes
-                // (which is really just the inactive container for each messenger
-                // showing inactive message types for that messenger)
-                $mt_boxes[ $messenger . '_i_box' ]         = esc_html__('Inactive Message Types', 'event_espresso');
-                $mt_template_args[ $messenger . '_i_box' ] = [
-                    'active_message_types'   => ! empty($active_mt_tabs) ? $this->_get_mt_tabs($active_mt_tabs) : '',
-                    'inactive_message_types' => isset(
-                        $this->_m_mt_settings['message_type_tabs'][ $messenger ]['inactive']
-                    )
-                        ? $this->_get_mt_tabs($this->_m_mt_settings['message_type_tabs'][ $messenger ]['inactive'])
-                        : '',
-                    'hidden'                 => $active ? '' : ' hidden',
-                    'hide_on_message'        => $hide_on_message,
-                    'hide_off_message'       => $hide_off_message,
-                    'messenger'              => $messenger,
-                    'active'                 => $active,
-                ];
-            }
-        }
-
-
-        // register messenger metaboxes
-        $m_template_path = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_messenger_mt_meta_box.template.php';
-        foreach ($m_boxes as $box => $label) {
-            $callback_args = ['template_path' => $m_template_path, 'template_args' => $m_template_args[ $box ]];
-            $msgr          = str_replace('_a_box', '', $box);
-            $this->addMetaBox(
-                'espresso_' . $msgr . '_settings',
-                $label,
-                function ($post, $metabox) {
-                    EEH_Template::display_template(
-                        $metabox['args']['template_path'],
-                        $metabox['args']['template_args']
-                    );
-                },
-                $this->_current_screen->id,
-                'normal',
-                'high',
-                $callback_args
-            );
-        }
-
-        // register message type metaboxes
-        $mt_template_path = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_messenger_meta_box.template.php';
-        foreach ($mt_boxes as $box => $label) {
-            $callback_args = [
-                'template_path' => $mt_template_path,
-                'template_args' => $mt_template_args[ $box ],
-            ];
-            $mt            = str_replace('_i_box', '', $box);
-            $this->addMetaBox(
-                'espresso_' . $mt . '_inactive_mts',
-                $label,
-                function ($post, $metabox) {
-                    EEH_Template::display_template(
-                        $metabox['args']['template_path'],
-                        $metabox['args']['template_args']
-                    );
-                },
-                $this->_current_screen->id,
-                'side',
-                'high',
-                $callback_args
-            );
-        }
-
-        // register metabox for global messages settings but only when on the main site.  On single site installs this
-        // will always result in the metabox showing, on multisite installs the metabox will only show on the main site.
-        if (is_main_site()) {
-            $this->addMetaBox(
-                'espresso_global_message_settings',
-                esc_html__('Global Message Settings', 'event_espresso'),
-                [$this, 'global_messages_settings_metabox_content'],
-                $this->_current_screen->id,
-                'normal',
-                'low',
-                []
-            );
-        }
-    }
-
-
-    /**
-     *  This generates the content for the global messages settings metabox.
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function global_messages_settings_metabox_content()
-    {
-        $form = $this->_generate_global_settings_form();
-        echo wp_kses(
-            $form->form_open(
-                $this->add_query_args_and_nonce(['action' => 'update_global_settings'], EE_MSG_ADMIN_URL),
-                'POST'
-            ),
-            AllowedTags::getWithFormTags()
-        );
-        echo wp_kses($form->get_html(), AllowedTags::getWithFormTags());
-        echo wp_kses($form->form_close(), AllowedTags::getWithFormTags());
-    }
-
-
-    /**
-     * This generates and returns the form object for the global messages settings.
-     *
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _generate_global_settings_form()
-    {
-        /** @var EE_Network_Core_Config $network_config */
-        $network_config = EE_Registry::instance()->NET_CFG->core;
-
-        return new EE_Form_Section_Proper(
-            [
-                'name'            => 'global_messages_settings',
-                'html_id'         => 'global_messages_settings',
-                'html_class'      => 'form-table',
-                'layout_strategy' => new EE_Admin_Two_Column_Layout(),
-                'subsections'     => apply_filters(
-                    'FHEE__Messages_Admin_Page__global_messages_settings_metabox_content__form_subsections',
-                    [
-                        'do_messages_on_same_request' => new EE_Select_Input(
-                            [
-                                true  => esc_html__('On the same request', 'event_espresso'),
-                                false => esc_html__('On a separate request', 'event_espresso'),
-                            ],
-                            [
-                                'default'         => $network_config->do_messages_on_same_request,
-                                'html_label_text' => esc_html__(
-                                    'Generate and send all messages:',
-                                    'event_espresso'
-                                ),
-                                'html_help_text'  => esc_html__(
-                                    'By default the messages system uses a more efficient means of processing messages on separate requests and utilizes the wp-cron scheduling system.  This makes things execute faster for people registering for your events.  However, if the wp-cron system is disabled on your site and there is no alternative in place, then you can change this so messages are always executed on the same request.',
-                                    'event_espresso'
-                                ),
-                            ]
-                        ),
-                        'delete_threshold'            => new EE_Select_Input(
-                            [
-                                0  => esc_html__('Forever', 'event_espresso'),
-                                3  => esc_html__('3 Months', 'event_espresso'),
-                                6  => esc_html__('6 Months', 'event_espresso'),
-                                9  => esc_html__('9 Months', 'event_espresso'),
-                                12 => esc_html__('12 Months', 'event_espresso'),
-                                24 => esc_html__('24 Months', 'event_espresso'),
-                                36 => esc_html__('36 Months', 'event_espresso'),
-                            ],
-                            [
-                                'default'         => EE_Registry::instance()->CFG->messages->delete_threshold,
-                                'html_label_text' => esc_html__('Cleanup of old messages:', 'event_espresso'),
-                                'html_help_text'  => esc_html__(
-                                    'You can control how long a record of processed messages is kept via this option.',
-                                    'event_espresso'
-                                ),
-                            ]
-                        ),
-                        'update_settings'             => new EE_Submit_Input(
-                            [
-                                'default'         => esc_html__('Update', 'event_espresso'),
-                                'html_label_text' => '',
-                            ]
-                        ),
-                    ]
-                ),
-            ]
-        );
-    }
-
-
-    /**
-     * This handles updating the global settings set on the admin page.
-     *
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    protected function _update_global_settings()
-    {
-        /** @var EE_Network_Core_Config $network_config */
-        $network_config  = EE_Registry::instance()->NET_CFG->core;
-        $messages_config = EE_Registry::instance()->CFG->messages;
-        $form            = $this->_generate_global_settings_form();
-        if ($form->was_submitted()) {
-            $form->receive_form_submission();
-            if ($form->is_valid()) {
-                $valid_data = $form->valid_data();
-                foreach ($valid_data as $property => $value) {
-                    $setter = 'set_' . $property;
-                    if (method_exists($network_config, $setter)) {
-                        $network_config->{$setter}($value);
-                    } elseif (
-                        property_exists($network_config, $property)
-                        && $network_config->{$property} !== $value
-                    ) {
-                        $network_config->{$property} = $value;
-                    } elseif (
-                        property_exists($messages_config, $property)
-                        && $messages_config->{$property} !== $value
-                    ) {
-                        $messages_config->{$property} = $value;
-                    }
-                }
-                // only update if the form submission was valid!
-                EE_Registry::instance()->NET_CFG->update_config(true, false);
-                EE_Registry::instance()->CFG->update_espresso_config();
-                EE_Error::overwrite_success();
-                EE_Error::add_success(esc_html__('Global message settings were updated', 'event_espresso'));
-            }
-        }
-        $this->_redirect_after_action(0, '', '', ['action' => 'settings'], true);
-    }
-
-
-    /**
-     * this prepares the messenger tabs that can be dragged in and out of messenger boxes to activate/deactivate
-     *
-     * @param array $tab_array This is an array of message type tab details used to generate the tabs
-     * @return string html formatted tabs
-     * @throws DomainException
-     */
-    protected function _get_mt_tabs($tab_array)
-    {
-        $tab_array = (array) $tab_array;
-        $template  = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_mt_settings_tab_item.template.php';
-        $tabs      = '';
-
-        foreach ($tab_array as $tab) {
-            $tabs .= EEH_Template::display_template($template, $tab, true);
-        }
-
-        return $tabs;
-    }
-
-
-    /**
-     * This prepares the content of the messenger meta box admin settings
-     *
-     * @param EE_messenger $messenger The messenger we're setting up content for
-     * @return string html formatted content
-     * @throws DomainException
-     */
-    protected function _get_messenger_box_content(EE_messenger $messenger)
-    {
-
-        $fields                                         = $messenger->get_admin_settings_fields();
-        $settings_template_args['template_form_fields'] = '';
-
-        // is $messenger active?
-        $settings_template_args['active'] = $this->_message_resource_manager->is_messenger_active($messenger->name);
-
-
-        if (! empty($fields)) {
-            $existing_settings = $messenger->get_existing_admin_settings();
-
-            foreach ($fields as $fldname => $fldprops) {
-                $field_id                         = $messenger->name . '-' . $fldname;
-                $template_form_field[ $field_id ] = [
-                    'name'       => 'messenger_settings[' . $field_id . ']',
-                    'label'      => $fldprops['label'],
-                    'input'      => $fldprops['field_type'],
-                    'type'       => $fldprops['value_type'],
-                    'required'   => $fldprops['required'],
-                    'validation' => $fldprops['validation'],
-                    'value'      => isset($existing_settings[ $field_id ])
-                        ? $existing_settings[ $field_id ]
-                        : $fldprops['default'],
-                    'css_class'  => '',
-                    'format'     => $fldprops['format'],
-                ];
-            }
-
-
-            $settings_template_args['template_form_fields'] = ! empty($template_form_field)
-                ? $this->_generate_admin_form_fields($template_form_field, 'string', 'ee_m_activate_form')
-                : '';
-        }
-
-        // we also need some hidden fields
-        $settings_template_args['hidden_fields'] = [
-            'messenger_settings[messenger]' . $messenger->name => [
-                'type'  => 'hidden',
-                'value' => $messenger->name,
-            ],
-            'type' . $messenger->name                          => [
-                'type'  => 'hidden',
-                'value' => 'messenger',
-            ],
-        ];
-
-        // make sure any active message types that are existing are included in the hidden fields
-        if (isset($this->_m_mt_settings['message_type_tabs'][ $messenger->name ]['active'])) {
-            foreach ($this->_m_mt_settings['message_type_tabs'][ $messenger->name ]['active'] as $mt => $values) {
-                $settings_template_args['hidden_fields'][ 'messenger_settings[message_types][' . $mt . ']' ] = [
-                    'type'  => 'hidden',
-                    'value' => $mt,
-                ];
-            }
-        }
-        $settings_template_args['hidden_fields'] = $this->_generate_admin_form_fields(
-            $settings_template_args['hidden_fields'],
-            'array'
-        );
-        $active                                  =
-            $this->_message_resource_manager->is_messenger_active($messenger->name);
-
-        $settings_template_args['messenger']           = $messenger->name;
-        $settings_template_args['description']         = $messenger->description;
-        $settings_template_args['show_hide_edit_form'] = $active ? '' : ' hidden';
-
-
-        $settings_template_args['show_hide_edit_form'] = $this->_message_resource_manager->is_messenger_active(
-            $messenger->name
-        )
-            ? $settings_template_args['show_hide_edit_form']
-            : ' hidden';
-
-        $settings_template_args['show_hide_edit_form'] = empty($settings_template_args['template_form_fields'])
-            ? ' hidden'
-            : $settings_template_args['show_hide_edit_form'];
-
-
-        $settings_template_args['on_off_action'] = $active ? 'messenger-off' : 'messenger-on';
-        $settings_template_args['nonce']         = wp_create_nonce('activate_' . $messenger->name . '_toggle_nonce');
-        $settings_template_args['on_off_status'] = $active;
-        $template                                = EE_MSG_TEMPLATE_PATH . 'ee_msg_m_settings_content.template.php';
-        return EEH_Template::display_template(
-            $template,
-            $settings_template_args,
-            true
-        );
-    }
-
-
-    /**
-     * used by ajax on the messages settings page to activate|deactivate the messenger
-     *
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    public function activate_messenger_toggle()
-    {
-        $success = true;
-        $this->_prep_default_response_for_messenger_or_message_type_toggle();
-        // let's check that we have required data
-
-        if (! $this->_active_messenger_name) {
-            EE_Error::add_error(
-                esc_html__('Messenger name needed to toggle activation. None given', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $success = false;
-        }
-
-        // do a nonce check here since we're not arriving via a normal route
-        $nonce     = $this->request->getRequestParam('activate_nonce', '');
-        $nonce_ref = "activate_{$this->_active_messenger_name}_toggle_nonce";
-
-        $this->_verify_nonce($nonce, $nonce_ref);
-
-
-        $status = $this->request->getRequestParam('status');
-        if (! $status) {
-            EE_Error::add_error(
-                esc_html__(
-                    'Messenger status needed to know whether activation or deactivation is happening. No status is given',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $success = false;
-        }
-
-        // do check to verify we have a valid status.
-        if ($status !== 'off' && $status !== 'on') {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__('The given status (%s) is not valid. Must be "off" or "on"', 'event_espresso'),
-                    $status
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $success = false;
-        }
-
-        if ($success) {
-            // made it here?  Stop dawdling then!!
-            $success = $status === 'off'
-                ? $this->_deactivate_messenger($this->_active_messenger_name)
-                : $this->_activate_messenger($this->_active_messenger_name);
-        }
-
-        $this->_template_args['success'] = $success;
-
-        // no special instructions so let's just do the json return (which should automatically do all the special stuff).
-        $this->_return_json();
-    }
-
-
-    /**
-     * used by ajax from the messages settings page to activate|deactivate a message type
-     *
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    public function activate_mt_toggle()
-    {
-        $success = true;
-        $this->_prep_default_response_for_messenger_or_message_type_toggle();
-
-        // let's make sure we have the necessary data
-        if (! $this->_active_message_type_name) {
-            EE_Error::add_error(
-                esc_html__('Message Type name needed to toggle activation. None given', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $success = false;
-        }
-
-        if (! $this->_active_messenger_name) {
-            EE_Error::add_error(
-                esc_html__('Messenger name needed to toggle activation. None given', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $success = false;
-        }
-
-        $status = $this->request->getRequestParam('status');
-        if (! $status) {
-            EE_Error::add_error(
-                esc_html__(
-                    'Messenger status needed to know whether activation or deactivation is happening. No status is given',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $success = false;
-        }
-
-
-        // do check to verify we have a valid status.
-        if ($status !== 'activate' && $status !== 'deactivate') {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__('The given status (%s) is not valid. Must be "active" or "inactive"', 'event_espresso'),
-                    $status
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $success = false;
-        }
-
-
-        // do a nonce check here since we're not arriving via a normal route
-        $nonce = $this->request->getRequestParam('mt_nonce', '');
-        $this->_verify_nonce($nonce, "{$this->_active_message_type_name}_nonce");
-
-        if ($success) {
-            // made it here? um, what are you waiting for then?
-            $success = $status === 'deactivate'
-                ? $this->_deactivate_message_type_for_messenger(
-                    $this->_active_messenger_name,
-                    $this->_active_message_type_name
-                )
-                : $this->_activate_message_type_for_messenger(
-                    $this->_active_messenger_name,
-                    $this->_active_message_type_name
-                );
-        }
-
-        $this->_template_args['success'] = $success;
-        $this->_return_json();
-    }
-
-
-    /**
-     * Takes care of processing activating a messenger and preparing the appropriate response.
-     *
-     * @param string $messenger_name The name of the messenger being activated
-     * @return bool
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _activate_messenger($messenger_name)
-    {
-        $active_messenger          = $this->_message_resource_manager->get_messenger($messenger_name);
-        $message_types_to_activate = $active_messenger instanceof EE_Messenger
-            ? $active_messenger->get_default_message_types()
-            : [];
-
-        // ensure is active
-        $this->_message_resource_manager->activate_messenger($active_messenger, $message_types_to_activate);
-
-        // set response_data for reload
-        foreach ($message_types_to_activate as $message_type_name) {
-            $message_type = $this->_message_resource_manager->get_message_type($message_type_name);
-            if (
-                $this->_message_resource_manager->is_message_type_active_for_messenger(
-                    $messenger_name,
-                    $message_type_name
-                )
-                && $message_type instanceof EE_message_type
-            ) {
-                $this->_template_args['data']['active_mts'][] = $message_type_name;
-                if ($message_type->get_admin_settings_fields()) {
-                    $this->_template_args['data']['mt_reload'][] = $message_type_name;
-                }
-            }
-        }
-
-        // add success message for activating messenger
-        return $this->_setup_response_message_for_activating_messenger_with_message_types($active_messenger);
-    }
-
-
-    /**
-     * Takes care of processing deactivating a messenger and preparing the appropriate response.
-     *
-     * @param string $messenger_name The name of the messenger being activated
-     * @return bool
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _deactivate_messenger($messenger_name)
-    {
-        $active_messenger = $this->_message_resource_manager->get_messenger($messenger_name);
-        $this->_message_resource_manager->deactivate_messenger($messenger_name);
-
-        return $this->_setup_response_message_for_deactivating_messenger_with_message_types($active_messenger);
-    }
-
-
-    /**
-     * Takes care of processing activating a message type for a messenger and preparing the appropriate response.
-     *
-     * @param string $messenger_name    The name of the messenger the message type is being activated for.
-     * @param string $message_type_name The name of the message type being activated for the messenger
-     * @return bool
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _activate_message_type_for_messenger($messenger_name, $message_type_name)
-    {
-        $active_messenger         = $this->_message_resource_manager->get_messenger($messenger_name);
-        $message_type_to_activate = $this->_message_resource_manager->get_message_type($message_type_name);
-
-        // ensure is active
-        $this->_message_resource_manager->activate_messenger($active_messenger, $message_type_name);
-
-        // set response for load
-        if (
-            $this->_message_resource_manager->is_message_type_active_for_messenger(
-                $messenger_name,
-                $message_type_name
-            )
-        ) {
-            $this->_template_args['data']['active_mts'][] = $message_type_name;
-            if ($message_type_to_activate->get_admin_settings_fields()) {
-                $this->_template_args['data']['mt_reload'][] = $message_type_name;
-            }
-        }
-
-        return $this->_setup_response_message_for_activating_messenger_with_message_types(
-            $active_messenger,
-            $message_type_to_activate
-        );
-    }
-
-
-    /**
-     * Takes care of processing deactivating a message type for a messenger and preparing the appropriate response.
-     *
-     * @param string $messenger_name    The name of the messenger the message type is being deactivated for.
-     * @param string $message_type_name The name of the message type being deactivated for the messenger
-     * @return bool
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _deactivate_message_type_for_messenger($messenger_name, $message_type_name)
-    {
-        $active_messenger = $this->_message_resource_manager->get_messenger($messenger_name);
-        /** @var EE_message_type $message_type_to_activate This will be present because it can't be toggled if it isn't */
-        $message_type_to_deactivate = $this->_message_resource_manager->get_message_type($message_type_name);
-        $this->_message_resource_manager->deactivate_message_type_for_messenger($message_type_name, $messenger_name);
-
-        return $this->_setup_response_message_for_deactivating_messenger_with_message_types(
-            $active_messenger,
-            $message_type_to_deactivate
-        );
-    }
-
-
-    /**
-     * This just initializes the defaults for activating messenger and message type responses.
-     */
-    protected function _prep_default_response_for_messenger_or_message_type_toggle()
-    {
-        $this->_template_args['data']['active_mts'] = [];
-        $this->_template_args['data']['mt_reload']  = [];
-    }
-
-
-    /**
-     * Setup appropriate response for activating a messenger and/or message types
-     *
-     * @param EE_messenger         $messenger
-     * @param EE_message_type|null $message_type
-     * @return bool
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _setup_response_message_for_activating_messenger_with_message_types(
-        $messenger,
-        EE_Message_Type $message_type = null
-    ) {
-        // if $messenger isn't a valid messenger object then get out.
-        if (! $messenger instanceof EE_Messenger) {
-            EE_Error::add_error(
-                esc_html__('The messenger being activated is not a valid messenger', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        // activated
-        if ($this->_template_args['data']['active_mts']) {
-            EE_Error::overwrite_success();
-            // activated a message type with the messenger
-            if ($message_type instanceof EE_message_type) {
-                EE_Error::add_success(
-                    sprintf(
-                        esc_html__(
-                            '%s message type has been successfully activated with the %s messenger',
-                            'event_espresso'
-                        ),
-                        ucwords($message_type->label['singular']),
-                        ucwords($messenger->label['singular'])
-                    )
-                );
-
-                // if message type was invoice then let's make sure we activate the invoice payment method.
-                if ($message_type->name === 'invoice') {
-                    EE_Registry::instance()->load_lib('Payment_Method_Manager');
-                    $pm = EE_Payment_Method_Manager::instance()->activate_a_payment_method_of_type('Invoice');
-                    if ($pm instanceof EE_Payment_Method) {
-                        EE_Error::add_attention(
-                            esc_html__(
-                                'Activating the invoice message type also automatically activates the invoice payment method.  If you do not wish the invoice payment method to be active, or to change its settings, visit the payment method admin page.',
-                                'event_espresso'
-                            )
-                        );
-                    }
-                }
-                // just toggles the entire messenger
-            } else {
-                EE_Error::add_success(
-                    sprintf(
-                        esc_html__('%s messenger has been successfully activated', 'event_espresso'),
-                        ucwords($messenger->label['singular'])
-                    )
-                );
-            }
-
-            return true;
-
-            // possible error condition. This will happen when our active_mts data is empty because it is validated for actual active
-            // message types after the activation process.  However its possible some messengers don't HAVE any default_message_types
-            // in which case we just give a success message for the messenger being successfully activated.
-        } else {
-            if (! $messenger->get_default_message_types()) {
-                // messenger doesn't have any default message types so still a success.
-                EE_Error::add_success(
-                    sprintf(
-                        esc_html__('%s messenger was successfully activated.', 'event_espresso'),
-                        ucwords($messenger->label['singular'])
-                    )
-                );
-
-                return true;
-            } else {
-                EE_Error::add_error(
-                    $message_type instanceof EE_message_type
-                    ? sprintf(
-                        esc_html__(
-                            '%s message type was not successfully activated with the %s messenger',
-                            'event_espresso'
-                        ),
-                        ucwords($message_type->label['singular']),
-                        ucwords($messenger->label['singular'])
-                    )
-                    : sprintf(
-                        esc_html__('%s messenger was not successfully activated', 'event_espresso'),
-                        ucwords($messenger->label['singular'])
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-
-                return false;
-            }
-        }
-    }
-
-
-    /**
-     * This sets up the appropriate response for deactivating a messenger and/or message type.
-     *
-     * @param EE_messenger         $messenger
-     * @param EE_message_type|null $message_type
-     * @return bool
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _setup_response_message_for_deactivating_messenger_with_message_types(
-        $messenger,
-        EE_message_type $message_type = null
-    ) {
-        EE_Error::overwrite_success();
-
-        // if $messenger isn't a valid messenger object then get out.
-        if (! $messenger instanceof EE_Messenger) {
-            EE_Error::add_error(
-                esc_html__('The messenger being deactivated is not a valid messenger', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-
-            return false;
-        }
-
-        if ($message_type instanceof EE_message_type) {
-            $message_type_name = $message_type->name;
-            EE_Error::add_success(
-                sprintf(
-                    esc_html__(
-                        '%s message type has been successfully deactivated for the %s messenger.',
-                        'event_espresso'
-                    ),
-                    ucwords($message_type->label['singular']),
-                    ucwords($messenger->label['singular'])
-                )
-            );
-        } else {
-            $message_type_name = '';
-            EE_Error::add_success(
-                sprintf(
-                    esc_html__('%s messenger has been successfully deactivated.', 'event_espresso'),
-                    ucwords($messenger->label['singular'])
-                )
-            );
-        }
-
-        // if messenger was html or message type was invoice then let's make sure we deactivate invoice payment method.
-        if (
-            $messenger->name === 'html'
-            && (
-                is_null($message_type)
-                || $message_type_name === 'invoice'
-            )
-        ) {
-            EE_Registry::instance()->load_lib('Payment_Method_Manager');
-            $count_updated = EE_Payment_Method_Manager::instance()->deactivate_payment_method('invoice');
-            if ($count_updated > 0) {
-                $msg = $message_type_name === 'invoice'
-                    ? esc_html__(
-                        'Deactivating the invoice message type also automatically deactivates the invoice payment method. In order for invoices to be generated the invoice message type must be active. If you completed this action by mistake, simply reactivate the invoice message type and then visit the payment methods admin page to reactivate the invoice payment method.',
-                        'event_espresso'
-                    )
-                    : esc_html__(
-                        'Deactivating the html messenger also automatically deactivates the invoice payment method.  In order for invoices to be generated the html messenger must be be active.  If you completed this action by mistake, simply reactivate the html messenger, then visit the payment methods admin page to reactivate the invoice payment method.',
-                        'event_espresso'
-                    );
-                EE_Error::add_attention($msg);
-            }
-        }
-
-        return true;
-    }
-
-
-    /**
-     * handles updating a message type form on messenger activation IF the message type has settings fields. (via ajax)
-     *
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function update_mt_form()
-    {
-        if (! $this->_active_messenger_name || ! $this->_active_message_type_name) {
-            EE_Error::add_error(
-                esc_html__('Require message type or messenger to send an updated form', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $this->_return_json();
-        }
-
-        $message_types = $this->get_installed_message_types();
-        $message_type  = $message_types[ $this->_active_message_type_name ];
-        $messenger     = $this->_message_resource_manager->get_active_messenger($this->_active_messenger_name);
-        $content       = $this->_message_type_settings_content($message_type, $messenger, true);
-
-        $this->_template_args['success'] = true;
-        $this->_template_args['content'] = $content;
-        $this->_return_json();
-    }
-
-
-    /**
-     * this handles saving the settings for a messenger or message type
-     *
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function save_settings()
-    {
-        $type = $this->request->getRequestParam('type');
-        if (! $type) {
-            EE_Error::add_error(
-                esc_html__(
-                    'Cannot save settings because type is unknown (messenger settings or message type settings?)',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $this->_template_args['error'] = true;
-            $this->_return_json();
-        }
-
-
-        if ($type === 'messenger') {
-            // this should be an array.
-            $settings  = $this->request->getRequestParam('messenger_settings', [], 'string', true);
-            $messenger = $settings['messenger'];
-            // remove messenger and message_types from settings array
-            unset($settings['messenger'], $settings['message_types']);
-            $this->_message_resource_manager->add_settings_for_messenger($messenger, $settings);
-        } elseif ($type === 'message_type') {
-            $settings     = $this->request->getRequestParam('message_type_settings', [], 'string', true);
-            $messenger    = $settings['messenger'];
-            $message_type = $settings['message_type'];
-            // remove messenger and message_types from settings array
-            unset($settings['messenger'], $settings['message_types']);
-            $this->_message_resource_manager->add_settings_for_message_type($messenger, $message_type, $settings);
-        }
-
-        // okay we should have the data all setup.  Now we just update!
-        $success = $this->_message_resource_manager->update_active_messengers_option();
-
-        if ($success) {
-            EE_Error::add_success(esc_html__('Settings updated', 'event_espresso'));
-        } else {
-            EE_Error::add_error(
-                esc_html__('Settings did not get updated', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-
-        $this->_template_args['success'] = $success;
-        $this->_return_json();
-    }
-
-
-
-
-    /**  EE MESSAGE PROCESSING ACTIONS **/
-
-
-    /**
-     * This immediately generates any EE_Message ID's that are selected that are EEM_Message::status_incomplete
-     * However, this does not send immediately, it just queues for sending.
-     *
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @since 4.9.0
-     */
-    protected function _generate_now()
-    {
-        EED_Messages::generate_now($this->_get_msg_ids_from_request());
-        $this->_redirect_after_action(false, '', '', [], true);
-    }
-
-
-    /**
-     * This immediately generates AND sends any EE_Message's selected that are EEM_Message::status_incomplete or that
-     * are EEM_Message::status_resend or EEM_Message::status_idle
-     *
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @since 4.9.0
-     */
-    protected function _generate_and_send_now()
-    {
-        EED_Messages::generate_and_send_now($this->_get_msg_ids_from_request());
-        $this->_redirect_after_action(false, '', '', [], true);
-    }
-
-
-    /**
-     * This queues any EEM_Message::status_sent EE_Message ids in the request for resending.
-     *
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @since 4.9.0
-     */
-    protected function _queue_for_resending()
-    {
-        EED_Messages::queue_for_resending($this->_get_msg_ids_from_request());
-        $this->_redirect_after_action(false, '', '', [], true);
-    }
-
-
-    /**
-     *  This sends immediately any EEM_Message::status_idle or EEM_Message::status_resend messages in the queue
-     *
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @since 4.9.0
-     */
-    protected function _send_now()
-    {
-        EED_Messages::send_now($this->_get_msg_ids_from_request());
-        $this->_redirect_after_action(false, '', '', [], true);
-    }
-
-
-    /**
-     * Deletes EE_messages for IDs in the request.
-     *
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @since 4.9.0
-     */
-    protected function _delete_ee_messages()
-    {
-        $MSG_IDs       = $this->_get_msg_ids_from_request();
-        $deleted_count = 0;
-        foreach ($MSG_IDs as $MSG_ID) {
-            if ($this->getMsgModel()->delete_by_ID($MSG_ID)) {
-                $deleted_count++;
-            }
-        }
-        if ($deleted_count) {
-            EE_Error::add_success(
-                esc_html(
-                    _n(
-                        'Message successfully deleted',
-                        'Messages successfully deleted',
-                        $deleted_count,
-                        'event_espresso'
-                    )
-                )
-            );
-        } else {
-            EE_Error::add_error(
-                _n('The message was not deleted.', 'The messages were not deleted', count($MSG_IDs), 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        $this->_redirect_after_action(false, '', '', [], true);
-    }
-
-
-    /**
-     *  This looks for 'MSG_ID' key in the request and returns an array of MSG_ID's if present.
-     *
-     * @return array
-     * @since 4.9.0
-     */
-    protected function _get_msg_ids_from_request()
-    {
-        $MSG_IDs = $this->request->getRequestParam('MSG_ID', [], 'string', true);
-        if (empty($MSG_IDs)) {
-            return [];
-        }
-        // if 'MSG_ID' was just a single ID (not an array)
-        // then $MSG_IDs will be something like [123] so $MSG_IDs[0] should be 123
-        // otherwise, $MSG_IDs was already an array where message IDs were used as the keys
-        return count($MSG_IDs) === 1 && isset($MSG_IDs[0])
-            ? $MSG_IDs
-            : array_keys($MSG_IDs);
-    }
+	}
+
+
+	/**
+	 * @param bool $new
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _insert_or_update_message_template($new = false)
+	{
+		$form_data    = $this->getMessageTemplateFormData();
+		$GRP_ID       = $form_data['GRP_ID'];
+		$messenger    = $form_data['MTP_messenger'];
+		$message_type = $form_data['MTP_message_type'];
+		$context      = $form_data['MTP_context'];
+
+		// if this is "new" then we need to generate the default contexts
+		// for the selected messenger/message_type for user to edit.
+		[$success, $query_args] = $new
+			? $this->generateNewTemplates($GRP_ID, $messenger, $message_type)
+			: $this->updateExistingTemplates($GRP_ID, $messenger, $message_type, $context, $form_data);
+
+		$success     = $success ? 1 : 0;
+		$action_desc = $new ? 'created' : 'updated';
+		$item_desc   = $this->generateUpdateDescription($messenger, $message_type, $context);
+		$override    = $this->performTestSendAfterUpdate($messenger, $message_type, $context);
+
+		$this->_redirect_after_action($success, $item_desc, $action_desc, $query_args, $override);
+	}
+
+
+	/**
+	 * retrieve and sanitize form data
+	 *
+	 * @return array
+	 * @since 4.10.29.p
+	 */
+	protected function getMessageTemplateFormData()
+	{
+		return [
+			'GRP_ID'           => $this->request->getRequestParam('GRP_ID', 0, 'int'),
+			'MTP_context'      => strtolower($this->request->getRequestParam('MTP_context', '')),
+			'MTP_messenger'    => strtolower($this->request->getRequestParam('MTP_messenger', '')),
+			'MTP_message_type' => strtolower($this->request->getRequestParam('MTP_message_type', '')),
+			'MTP_user_id'      => $this->request->getRequestParam('MTP_user_id', 0, 'int'),
+			'MTP_is_global'    => $this->request->getRequestParam('MTP_is_global', 0, 'int'),
+			'MTP_is_override'  => $this->request->getRequestParam('MTP_is_override', 0, 'int'),
+			'MTP_deleted'      => $this->request->getRequestParam('MTP_deleted', 0, 'int'),
+			'MTP_is_active'    => $this->request->getRequestParam('MTP_is_active', 0, 'int'),
+		];
+	}
+
+
+	/**
+	 * @param int    $GRP_ID
+	 * @param string $messenger
+	 * @param string $message_type
+	 * @return array no return on AJAX requests
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since 4.10.29.p
+	 */
+	private function generateNewTemplates($GRP_ID, $messenger, $message_type)
+	{
+		$new_templates = $this->_generate_new_templates($messenger, [$message_type], $GRP_ID);
+		$success       = ! empty($new_templates);
+
+		// we return things differently if doing ajax
+		if ($this->request->isAjax()) {
+			$this->_template_args['success'] = $success;
+			$this->_template_args['error']   = ! $success;
+			$this->_template_args['content'] = '';
+			$this->_template_args['data']    = [
+				'grpID'        => $new_templates['GRP_ID'],
+				'templateName' => $new_templates['template_name'],
+			];
+			if ($success) {
+				EE_Error::overwrite_success();
+				EE_Error::add_success(
+					esc_html__(
+						'The new template has been created and automatically selected for this event.  You can edit the new template by clicking the edit button.  Note before this template is assigned to this event, the event must be saved.',
+						'event_espresso'
+					)
+				);
+			}
+			$this->_return_json();
+		}
+		return [
+			$success,
+			// 'query_args'
+			[
+				'id'      => $new_templates['GRP_ID'],
+				'context' => $new_templates['MTP_context'],
+				'action'  => 'edit_message_template',
+			],
+		];
+	}
+
+
+	/**
+	 * @param int    $GRP_ID
+	 * @param string $messenger
+	 * @param string $message_type
+	 * @param string $context
+	 * @param array  $form_data
+	 * @return array
+	 * @throws EE_Error
+	 * @since 4.10.29.p
+	 */
+	private function updateExistingTemplates(
+		$GRP_ID,
+		$messenger,
+		$message_type,
+		$context,
+		array $form_data
+	) {
+		$success         = false;
+		$template_fields = $this->getTemplateFields();
+		if ($template_fields) {
+			// if field data is valid, then success will be true
+			$success = $this->validateTemplateFields(
+				$messenger,
+				$message_type,
+				$context,
+				$template_fields
+			);
+			if ($success) {
+				$field_data = [];
+				foreach ($template_fields as $template_field => $content) {
+					// combine top-level form data with content for this field
+					$field_data = $this->getTemplateFieldFormData($content, $form_data);
+					$success    = $this->updateMessageTemplates($template_field, $field_data) ? $success : false;
+				}
+				// we can use the last set_column_values for the MTPG update
+				// (because its the same for all of these specific MTPs)
+				$success = $this->updateMessageTemplateGroup($field_data) ? $success : false;
+			}
+		}
+
+		return [
+			$success,
+			// 'query_args'
+			[
+				'id'      => $GRP_ID,
+				'context' => $context,
+				'action'  => 'edit_message_template',
+			],
+		];
+	}
+
+
+	/**
+	 * @return array
+	 * @since 4.10.29.p
+	 */
+	private function getTemplateFields()
+	{
+		$template_fields = $this->request->getRequestParam('MTP_template_fields', null, 'html', true);
+		if (empty($template_fields)) {
+			EE_Error::add_error(
+				esc_html__(
+					'There was a problem saving the template fields from the form because I didn\'t receive any actual template field data.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return null;
+		}
+		// messages content is expected to be escaped
+		return EEH_Array::addSlashesRecursively($template_fields);
+	}
+
+
+	/**
+	 * @param string $messenger
+	 * @param string $message_type
+	 * @param string $context
+	 * @param array  $template_fields
+	 * @return bool
+	 * @throws EE_Error
+	 * @since   4.10.29.p
+	 */
+	private function validateTemplateFields(
+		$messenger,
+		$message_type,
+		$context,
+		array $template_fields
+	) {
+		// first validate all fields!
+		// this filter allows client code to add its own validation to the template fields as well.
+		// returning an empty array means everything passed validation.
+		// errors in validation should be represented in an array with the following shape:
+		// array(
+		//   'fieldname' => array(
+		//          'msg' => 'error message'
+		//          'value' => 'value for field producing error'
+		// )
+		$custom_validation = (array) apply_filters(
+			'FHEE__Messages_Admin_Page___insert_or_update_message_template__validates',
+			[],
+			$template_fields,
+			$context,
+			$messenger,
+			$message_type
+		);
+
+		$system_validation = $this->getMtgModel()->validate(
+			$template_fields,
+			$context,
+			$messenger,
+			$message_type
+		);
+
+		$system_validation = ! is_array($system_validation) && $system_validation ? [] : $system_validation;
+		$validates         = array_merge($custom_validation, $system_validation);
+
+		// if $validate returned error messages (i.e. is_array()) then we need to process them and setup an
+		// appropriate response. HMM, dang this isn't correct, $validates will ALWAYS be an array.
+		//  WE need to make sure there is no actual error messages in validates.
+		if (empty($validates)) {
+			return true;
+		}
+
+		// add the transient so when the form loads we know which fields to highlight
+		$this->_add_transient('edit_message_template', $validates);
+		// setup notices
+		foreach ($validates as $error) {
+			if (isset($error['msg'])) {
+				EE_Error::add_error($error['msg'], __FILE__, __FUNCTION__, __LINE__);
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * @param array $field_data
+	 * @param array $form_data
+	 * @return array
+	 * @since   4.10.29.p
+	 */
+	private function getTemplateFieldFormData(array $field_data, array $form_data)
+	{
+		return $form_data + [
+				'MTP_ID'             => $field_data['MTP_ID'],
+				'MTP_template_field' => $field_data['name'],
+				// if they aren't allowed to use all JS, restrict them to standard allowed post tags
+				'MTP_content'        => ! current_user_can('unfiltered_html')
+					? $this->sanitizeMessageTemplateContent($field_data['content'])
+					: $field_data['content'],
+			];
+	}
+
+
+	/**
+	 * @param string $template_field
+	 * @param array  $form_data
+	 * @return bool
+	 * @throws EE_Error
+	 * @since 4.10.29.p
+	 */
+	private function updateMessageTemplates($template_field, array $form_data)
+	{
+		$MTP_ID                  = $form_data['MTP_ID'];
+		$message_template_fields = [
+			'GRP_ID'             => $form_data['GRP_ID'],
+			'MTP_template_field' => $form_data['MTP_template_field'],
+			'MTP_context'        => $form_data['MTP_context'],
+			'MTP_content'        => $form_data['MTP_content'],
+		];
+
+		$hasMtpID = ! empty($MTP_ID);
+		// if we have a MTP_ID for this field then update it, otherwise insert.
+		// this has already been through the template field validator and sanitized, so it will be
+		// safe to insert this field.  Why insert?  This typically happens when we introduce a new
+		// message template field in a messenger/message type and existing users don't have the
+		// default setup for it.
+		// @link https://events.codebasehq.com/projects/event-espresso/tickets/9465
+		$updated = $hasMtpID
+			? $this->getMtpModel()->update($message_template_fields, [['MTP_ID' => $MTP_ID]])
+			: $this->getMtpModel()->insert($message_template_fields);
+
+		$insert_failed = ! $hasMtpID && ! $updated;
+		// updates will return 0 if the field was not changed (ie: no changes = nothing actually updated)
+		// but we won't consider that a problem, but if it returns false, then something went BOOM!
+		$update_failed = $hasMtpID && $updated === false;
+
+		if ($insert_failed || $update_failed) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__('%s field was NOT updated for some reason', 'event_espresso'),
+					$template_field
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * @param array $form_data
+	 * @return bool
+	 * @throws EE_Error
+	 * @since 4.10.29.p
+	 */
+	private function updateMessageTemplateGroup(array $form_data)
+	{
+		$GRP_ID  = $form_data['GRP_ID'];
+		$updated = $this->getMtgModel()->update(
+		// fields and values
+			[
+				'MTP_user_id'      => $form_data['MTP_user_id'],
+				'MTP_messenger'    => $form_data['MTP_messenger'],
+				'MTP_message_type' => $form_data['MTP_message_type'],
+				'MTP_is_global'    => $form_data['MTP_is_global'],
+				'MTP_is_override'  => $form_data['MTP_is_override'],
+				'MTP_deleted'      => $form_data['MTP_deleted'],
+				'MTP_is_active'    => $form_data['MTP_is_active'],
+				'MTP_name'         => $this->request->getRequestParam('ee_msg_non_global_fields[MTP_name]', ''),
+				'MTP_description'  => $this->request->getRequestParam(
+					'ee_msg_non_global_fields[MTP_description]',
+					''
+				),
+			],
+			// where
+			[['GRP_ID' => $GRP_ID]]
+		);
+
+		if ($updated === false) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'The Message Template Group (%d) was NOT updated for some reason',
+						'event_espresso'
+					),
+					$form_data['GRP_ID']
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		// k now we need to ensure the template_pack and template_variation fields are set.
+		$template_pack      = $this->request->getRequestParam('MTP_template_pack', 'default');
+		$template_variation = $this->request->getRequestParam('MTP_template_variation', 'default');
+
+		$message_template_group = $this->getMtgModel()->get_one_by_ID($GRP_ID);
+		if ($message_template_group instanceof EE_Message_Template_Group) {
+			$message_template_group->set_template_pack_name($template_pack);
+			$message_template_group->set_template_pack_variation($template_variation);
+		}
+		return true;
+	}
+
+
+	/**
+	 * recursively runs wp_kses() on message template content in a model safe manner
+	 *
+	 * @param array|string $content
+	 * @return array|string
+	 * @since   4.10.29.p
+	 */
+	private function sanitizeMessageTemplateContent($content)
+	{
+		if (is_array($content)) {
+			foreach ($content as $key => $value) {
+				$content[ $key ] = $this->sanitizeMessageTemplateContent($value);
+			}
+			return $content;
+		}
+		// remove slashes so wp_kses() works properly
+		// wp_kses_stripslashes() only removes slashes from double-quotes,
+		// so attributes using single quotes always appear invalid.
+		$content = stripslashes($content);
+		$content = wp_kses($content, wp_kses_allowed_html('post'));
+		// But currently the models expect slashed data, so after wp_kses()
+		// runs we need to re-slash the data. Sheesh.
+		// See https://events.codebasehq.com/projects/event-espresso/tickets/11211#update-47321587
+		return addslashes($content);
+	}
+
+
+	/**
+	 * @param string $messenger
+	 * @param string $message_type
+	 * @param string $context
+	 * @return string
+	 * @since 4.10.29.p
+	 */
+	private function generateUpdateDescription($messenger, $message_type, $context)
+	{
+		// need the message type and messenger objects to be able to use the labels for the notices
+		$messenger_object = $this->_message_resource_manager->get_messenger($messenger);
+		$messenger_label  = $messenger_object instanceof EE_messenger
+			? ucwords($messenger_object->label['singular'])
+			: '';
+
+		$message_type_object = $this->_message_resource_manager->get_message_type($message_type);
+		$message_type_label  = $message_type_object instanceof EE_message_type
+			? ucwords($message_type_object->label['singular'])
+			: '';
+
+		$context   = ucwords(str_replace('_', ' ', $context));
+		$item_desc = $messenger_label && $message_type_label
+			? $messenger_label . ' ' . $message_type_label . ' ' . $context . ' '
+			: '';
+		$item_desc .= 'Message Template';
+		return $item_desc;
+	}
+
+
+	/**
+	 * @param string $messenger
+	 * @param string $message_type
+	 * @param string $context
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since 4.10.29.p
+	 */
+	private function performTestSendAfterUpdate($messenger, $message_type, $context)
+	{
+		// was a test send triggered?
+		if ($this->request->requestParamIsSet('test_button')) {
+			EE_Error::overwrite_success();
+			$this->_do_test_send($context, $messenger, $message_type);
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * processes a test send request to do an actual messenger delivery test for the given message template being tested
+	 *
+	 * @param string $context      what context being tested
+	 * @param string $messenger    messenger being tested
+	 * @param string $message_type message type being tested
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _do_test_send($context, $messenger, $message_type)
+	{
+		// set things up for preview
+		$this->request->setRequestParam('messenger', $messenger);
+		$this->request->setRequestParam('message_type', $message_type);
+		$this->request->setRequestParam('context', $context);
+		$GRP_ID = $this->request->getRequestParam('GRP_ID', 0, 'int');
+		$this->request->setRequestParam('GRP_ID', $GRP_ID);
+
+		$active_messenger  = $this->_message_resource_manager->get_active_messenger($messenger);
+		$test_settings_fld = $this->request->getRequestParam('test_settings_fld', [], 'string', true);
+
+		// let's save any existing fields that might be required by the messenger
+		if (
+			! empty($test_settings_fld)
+			&& $active_messenger instanceof EE_messenger
+			&& apply_filters(
+				'FHEE__Messages_Admin_Page__do_test_send__set_existing_test_settings',
+				true,
+				$test_settings_fld,
+				$active_messenger
+			)
+		) {
+			$active_messenger->set_existing_test_settings($test_settings_fld);
+		}
+
+		/**
+		 * Use filter to add additional controls on whether message can send or not
+		 */
+		if (
+			apply_filters(
+				'FHEE__Messages_Admin_Page__do_test_send__can_send',
+				true,
+				$context,
+				$this->request->requestParams(),
+				$messenger,
+				$message_type
+			)
+		) {
+			if (EEM_Event::instance()->count() > 0) {
+				$success = $this->_preview_message(true);
+				if ($success) {
+					EE_Error::add_success(esc_html__('Test message sent', 'event_espresso'));
+				} else {
+					EE_Error::add_error(
+						esc_html__('The test message was not sent', 'event_espresso'),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+				}
+			} else {
+				$this->noEventsErrorMessage(true);
+			}
+		}
+	}
+
+
+	/**
+	 * _generate_new_templates
+	 * This will handle the messenger, message_type selection when "adding a new custom template" for an event and will
+	 * automatically create the defaults for the event.  The user would then be redirected to edit the default context
+	 * for the event.
+	 *
+	 *
+	 * @param string $messenger      the messenger we are generating templates for
+	 * @param array  $message_types  array of message types that the templates are generated for.
+	 * @param int    $GRP_ID         If this is a custom template being generated then a GRP_ID needs to be included to
+	 *                               indicate the message_template_group being used as the base.
+	 *
+	 * @param bool   $global
+	 *
+	 * @return array|bool array of data required for the redirect to the correct edit page or bool if
+	 *                               encountering problems.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _generate_new_templates($messenger, $message_types, $GRP_ID = 0, $global = false)
+	{
+		// if no $message_types are given then that's okay... this may be a messenger that just adds shortcodes, so we
+		// just don't generate any templates.
+		if (empty($message_types)) {
+			return [];
+		}
+
+		$templates = EEH_MSG_Template::generate_new_templates($messenger, $message_types, $GRP_ID, $global);
+		return $templates[0];
+	}
+
+
+	/**
+	 * [_trash_or_restore_message_template]
+	 *
+	 * @param boolean $trash  whether to move an item to trash/restore (TRUE) or restore it (FALSE)
+	 * @param boolean $all    whether this is going to trash/restore all contexts within a template group (TRUE) OR just
+	 *                        an individual context (FALSE).
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _trash_or_restore_message_template($trash = true, $all = false)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+
+		$success = 1;
+
+		// incoming GRP_IDs
+		if ($all) {
+			// Checkboxes
+			$checkboxes = $this->request->getRequestParam('checkbox', [], 'int', true);
+			if (! empty($checkboxes)) {
+				// if array has more than one element then success message should be plural.
+				// todo: what about nonce?
+				$success = count($checkboxes) > 1 ? 2 : 1;
+
+				// cycle through checkboxes
+				while (list($GRP_ID, $value) = each($checkboxes)) {
+					$trashed_or_restored = $trash
+						? $this->getMtgModel()->delete_by_ID($GRP_ID)
+						: $this->getMtgModel()->restore_by_ID($GRP_ID);
+					if (! $trashed_or_restored) {
+						$success = 0;
+					}
+				}
+			} else {
+				// grab single GRP_ID and handle
+				$GRP_ID = $this->request->getRequestParam('id', 0, 'int');
+				if (! empty($GRP_ID)) {
+					$trashed_or_restored = $trash
+						? $this->getMtgModel()->delete_by_ID($GRP_ID)
+						: $this->getMtgModel()->restore_by_ID($GRP_ID);
+					if (! $trashed_or_restored) {
+						$success = 0;
+					}
+				} else {
+					$success = 0;
+				}
+			}
+		}
+
+		$action_desc = $trash
+			? esc_html__('moved to the trash', 'event_espresso')
+			: esc_html__('restored', 'event_espresso');
+
+		$template_switch = $this->request->getRequestParam('template_switch', false, 'bool');
+		$action_desc     = $template_switch ? esc_html__('switched', 'event_espresso') : $action_desc;
+
+		$item_desc = $all ? _n(
+			'Message Template Group',
+			'Message Template Groups',
+			$success,
+			'event_espresso'
+		) : _n('Message Template Context', 'Message Template Contexts', $success, 'event_espresso');
+
+		$item_desc = $template_switch
+			? _n('template', 'templates', $success, 'event_espresso')
+			: $item_desc;
+
+		$this->_redirect_after_action($success, $item_desc, $action_desc, []);
+	}
+
+
+	/**
+	 * [_delete_message_template]
+	 * NOTE: this handles not only the deletion of the groups but also all the templates belonging to that group.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _delete_message_template()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+
+		// checkboxes
+		$checkboxes = $this->request->getRequestParam('checkbox', [], 'int', true);
+		if (! empty($checkboxes)) {
+			// if array has more than one element then success message should be plural
+			$success = count($checkboxes) > 1 ? 2 : 1;
+
+			// cycle through bulk action checkboxes
+			while (list($GRP_ID, $value) = each($checkboxes)) {
+				$success = $this->_delete_mtp_permanently($GRP_ID) ? $success : false;
+			}
+		} else {
+			// grab single grp_id and delete
+			$GRP_ID  = $this->request->getRequestParam('id', 0, 'int');
+			$success = $this->_delete_mtp_permanently($GRP_ID);
+		}
+
+		$this->_redirect_after_action($success, 'Message Templates', 'deleted', []);
+	}
+
+
+	/**
+	 * helper for permanently deleting a mtP group and all related message_templates
+	 *
+	 * @param int  $GRP_ID        The group being deleted
+	 * @param bool $include_group whether to delete the Message Template Group as well.
+	 * @return bool boolean to indicate the success of the deletes or not.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws ReflectionException
+	 */
+	private function _delete_mtp_permanently($GRP_ID, $include_group = true)
+	{
+		$success = true;
+		// first let's GET this group
+		$MTG = $this->getMtgModel()->get_one_by_ID($GRP_ID);
+		// then delete permanently all the related Message Templates
+		$deleted = $MTG->delete_related_permanently('Message_Template');
+
+		if ($deleted === 0) {
+			$success = false;
+		}
+
+		// now delete permanently this particular group
+
+		if ($include_group && ! $MTG->delete_permanently()) {
+			$success = false;
+		}
+
+		return $success;
+	}
+
+
+	/**
+	 *    _learn_more_about_message_templates_link
+	 *
+	 * @access protected
+	 * @return string
+	 */
+	protected function _learn_more_about_message_templates_link()
+	{
+		return '<a class="hidden" style="margin:0 20px; cursor:pointer; font-size:12px;" >'
+			   . esc_html__('learn more about how message templates works', 'event_espresso')
+			   . '</a>';
+	}
+
+
+	/**
+	 * Used for setting up messenger/message type activation.  This loads up the initial view.  The rest is handled by
+	 * ajax and other routes.
+	 *
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	protected function _settings()
+	{
+		$this->_set_m_mt_settings();
+
+		// let's setup the messenger tabs
+		$this->_template_args['admin_page_header'] = EEH_Tabbed_Content::tab_text_links(
+			$this->_m_mt_settings['messenger_tabs'],
+			'messenger_links',
+			'|',
+			$this->request->getRequestParam('selected_messenger', 'email')
+		);
+
+		$this->_template_args['before_admin_page_content'] = '<div class="ui-widget ui-helper-clearfix">';
+		$this->_template_args['after_admin_page_content']  = '</div><!-- end .ui-widget -->';
+
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * This sets the $_m_mt_settings property for when needed (used on the Messages settings page)
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws DomainException
+	 */
+	protected function _set_m_mt_settings()
+	{
+		// first if this is already set then lets get out no need to regenerate data.
+		if (! empty($this->_m_mt_settings)) {
+			return;
+		}
+
+		// get all installed messengers and message_types
+		$messengers    = $this->_message_resource_manager->installed_messengers();
+		$message_types = $this->_message_resource_manager->installed_message_types();
+
+
+		// assemble the array for the _tab_text_links helper
+
+		foreach ($messengers as $messenger) {
+			$active = $this->_message_resource_manager->is_messenger_active($messenger->name);
+			$class = 'ee-messenger-' .  sanitize_key($messenger->label['singular']);
+			$this->_m_mt_settings['messenger_tabs'][ $messenger->name ] = [
+				'label' => ucwords($messenger->label['singular']),
+				'class' => $active ? "{$class} messenger-active" : $class,
+				'href'  => $messenger->name,
+				'title' => esc_html__('Modify this Messenger', 'event_espresso'),
+				'slug'  => $messenger->name,
+				'obj'   => $messenger,
+				'icon' => $active
+					? '<span class="dashicons dashicons-yes-alt"></span>'
+					: '<span class="dashicons dashicons-remove"></span>',
+			];
+
+
+			$message_types_for_messenger = $messenger->get_valid_message_types();
+
+			foreach ($message_types as $message_type) {
+				// first we need to verify that this message type is valid with this messenger. Cause if it isn't then
+				// it shouldn't show in either the inactive OR active metabox.
+				if (! in_array($message_type->name, $message_types_for_messenger, true)) {
+					continue;
+				}
+
+				$a_or_i = $this->_message_resource_manager->is_message_type_active_for_messenger(
+					$messenger->name,
+					$message_type->name
+				)
+					? 'active'
+					: 'inactive';
+
+				$this->_m_mt_settings['message_type_tabs'][ $messenger->name ][ $a_or_i ][ $message_type->name ] = [
+					'label'    => ucwords($message_type->label['singular']),
+					'class'    => 'message-type-' . $a_or_i,
+					'slug_id'  => $message_type->name . '-messagetype-' . $messenger->name,
+					'mt_nonce' => wp_create_nonce($message_type->name . '_nonce'),
+					'href'     => 'espresso_' . $message_type->name . '_message_type_settings',
+					'title'    => $a_or_i === 'active'
+						? esc_html__('Drag this message type to the Inactive window to deactivate', 'event_espresso')
+						: esc_html__('Drag this message type to the messenger to activate', 'event_espresso'),
+					'content'  => $a_or_i === 'active'
+						? $this->_message_type_settings_content($message_type, $messenger, true)
+						: $this->_message_type_settings_content($message_type, $messenger),
+					'slug'     => $message_type->name,
+					'active'   => $a_or_i === 'active',
+					'obj'      => $message_type,
+				];
+			}
+		}
+	}
+
+
+	/**
+	 * This just prepares the content for the message type settings
+	 *
+	 * @param EE_message_type $message_type The message type object
+	 * @param EE_messenger    $messenger    The messenger object
+	 * @param boolean         $active       Whether the message type is active or not
+	 * @return string html output for the content
+	 * @throws DomainException
+	 */
+	protected function _message_type_settings_content($message_type, $messenger, $active = false)
+	{
+		// get message type fields
+		$fields                                         = $message_type->get_admin_settings_fields();
+		$settings_template_args['template_form_fields'] = '';
+
+		if (! empty($fields) && $active) {
+			$existing_settings = $message_type->get_existing_admin_settings($messenger->name);
+			foreach ($fields as $fldname => $fldprops) {
+				$field_id                         = $messenger->name . '-' . $message_type->name . '-' . $fldname;
+				$template_form_field[ $field_id ] = [
+					'name'       => 'message_type_settings[' . $fldname . ']',
+					'label'      => $fldprops['label'],
+					'input'      => $fldprops['field_type'],
+					'type'       => $fldprops['value_type'],
+					'required'   => $fldprops['required'],
+					'validation' => $fldprops['validation'],
+					'value'      => isset($existing_settings[ $fldname ])
+						? $existing_settings[ $fldname ]
+						: $fldprops['default'],
+					'options'    => isset($fldprops['options'])
+						? $fldprops['options']
+						: [],
+					'default'    => isset($existing_settings[ $fldname ])
+						? $existing_settings[ $fldname ]
+						: $fldprops['default'],
+					'css_class'  => 'no-drag',
+					'format'     => $fldprops['format'],
+				];
+			}
+
+
+			$settings_template_args['template_form_fields'] = ! empty($template_form_field)
+				? $this->_generate_admin_form_fields(
+					$template_form_field,
+					'string',
+					'ee_mt_activate_form'
+				)
+				: '';
+		}
+
+		$settings_template_args['description'] = $message_type->description;
+		// we also need some hidden fields
+		$hidden_fields = [
+			'message_type_settings[messenger]' . $message_type->name    => [
+				'type'  => 'hidden',
+				'value' => $messenger->name,
+			],
+			'message_type_settings[message_type]' . $message_type->name => [
+				'type'  => 'hidden',
+				'value' => $message_type->name,
+			],
+			'type' . $message_type->name                                => [
+				'type'  => 'hidden',
+				'value' => 'message_type',
+			],
+		];
+
+		$settings_template_args['hidden_fields'] = $this->_generate_admin_form_fields(
+			$hidden_fields,
+			'array'
+		);
+		$settings_template_args['show_form']     = empty($settings_template_args['template_form_fields'])
+			? ' hidden'
+			: '';
+
+
+		$template = EE_MSG_TEMPLATE_PATH . 'ee_msg_mt_settings_content.template.php';
+		return EEH_Template::display_template($template, $settings_template_args, true);
+	}
+
+
+	/**
+	 * Generate all the metaboxes for the message types and register them for the messages settings page.
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws DomainException
+	 */
+	protected function _messages_settings_metaboxes()
+	{
+		$this->_set_m_mt_settings();
+		$m_boxes         = $mt_boxes = [];
+		$m_template_args = $mt_template_args = [];
+
+		$selected_messenger = $this->request->getRequestParam('selected_messenger', 'email');
+
+		if (isset($this->_m_mt_settings['messenger_tabs'])) {
+			foreach ($this->_m_mt_settings['messenger_tabs'] as $messenger => $tab_array) {
+				$is_messenger_active = $this->_message_resource_manager->is_messenger_active($messenger);
+				$hide_on_message     = $is_messenger_active ? '' : 'hidden';
+				$hide_off_message    = $is_messenger_active ? 'hidden' : '';
+
+				// messenger meta boxes
+				$active         = $selected_messenger === $messenger;
+				$active_mt_tabs = isset($this->_m_mt_settings['message_type_tabs'][ $messenger ]['active'])
+					? $this->_m_mt_settings['message_type_tabs'][ $messenger ]['active']
+					: '';
+
+				$m_boxes[ $messenger . '_a_box' ] = sprintf(
+					esc_html__('%s Settings', 'event_espresso'),
+					$tab_array['label']
+				);
+
+				$m_template_args[ $messenger . '_a_box' ] = [
+					'active_message_types'   => ! empty($active_mt_tabs) ? $this->_get_mt_tabs($active_mt_tabs) : '',
+					'inactive_message_types' => isset(
+						$this->_m_mt_settings['message_type_tabs'][ $messenger ]['inactive']
+					)
+						? $this->_get_mt_tabs($this->_m_mt_settings['message_type_tabs'][ $messenger ]['inactive'])
+						: '',
+					'content'                => $this->_get_messenger_box_content($tab_array['obj']),
+					'hidden'                 => $active ? '' : ' hidden',
+					'hide_on_message'        => $hide_on_message,
+					'messenger'              => $messenger,
+					'active'                 => $active,
+				];
+
+				// message type meta boxes
+				// (which is really just the inactive container for each messenger
+				// showing inactive message types for that messenger)
+				$mt_boxes[ $messenger . '_i_box' ]         = esc_html__('Inactive Message Types', 'event_espresso');
+				$mt_template_args[ $messenger . '_i_box' ] = [
+					'active_message_types'   => ! empty($active_mt_tabs) ? $this->_get_mt_tabs($active_mt_tabs) : '',
+					'inactive_message_types' => isset(
+						$this->_m_mt_settings['message_type_tabs'][ $messenger ]['inactive']
+					)
+						? $this->_get_mt_tabs($this->_m_mt_settings['message_type_tabs'][ $messenger ]['inactive'])
+						: '',
+					'hidden'                 => $active ? '' : ' hidden',
+					'hide_on_message'        => $hide_on_message,
+					'hide_off_message'       => $hide_off_message,
+					'messenger'              => $messenger,
+					'active'                 => $active,
+				];
+			}
+		}
+
+
+		// register messenger metaboxes
+		$m_template_path = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_messenger_mt_meta_box.template.php';
+		foreach ($m_boxes as $box => $label) {
+			$callback_args = ['template_path' => $m_template_path, 'template_args' => $m_template_args[ $box ]];
+			$msgr          = str_replace('_a_box', '', $box);
+			$this->addMetaBox(
+				'espresso_' . $msgr . '_settings',
+				$label,
+				function ($post, $metabox) {
+					EEH_Template::display_template(
+						$metabox['args']['template_path'],
+						$metabox['args']['template_args']
+					);
+				},
+				$this->_current_screen->id,
+				'normal',
+				'high',
+				$callback_args
+			);
+		}
+
+		// register message type metaboxes
+		$mt_template_path = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_messenger_meta_box.template.php';
+		foreach ($mt_boxes as $box => $label) {
+			$callback_args = [
+				'template_path' => $mt_template_path,
+				'template_args' => $mt_template_args[ $box ],
+			];
+			$mt            = str_replace('_i_box', '', $box);
+			$this->addMetaBox(
+				'espresso_' . $mt . '_inactive_mts',
+				$label,
+				function ($post, $metabox) {
+					EEH_Template::display_template(
+						$metabox['args']['template_path'],
+						$metabox['args']['template_args']
+					);
+				},
+				$this->_current_screen->id,
+				'side',
+				'high',
+				$callback_args
+			);
+		}
+
+		// register metabox for global messages settings but only when on the main site.  On single site installs this
+		// will always result in the metabox showing, on multisite installs the metabox will only show on the main site.
+		if (is_main_site()) {
+			$this->addMetaBox(
+				'espresso_global_message_settings',
+				esc_html__('Global Message Settings', 'event_espresso'),
+				[$this, 'global_messages_settings_metabox_content'],
+				$this->_current_screen->id,
+				'normal',
+				'low',
+				[]
+			);
+		}
+	}
+
+
+	/**
+	 *  This generates the content for the global messages settings metabox.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function global_messages_settings_metabox_content()
+	{
+		$form = $this->_generate_global_settings_form();
+		echo wp_kses(
+			$form->form_open(
+				$this->add_query_args_and_nonce(['action' => 'update_global_settings'], EE_MSG_ADMIN_URL),
+				'POST'
+			),
+			AllowedTags::getWithFormTags()
+		);
+		echo wp_kses($form->get_html(), AllowedTags::getWithFormTags());
+		echo wp_kses($form->form_close(), AllowedTags::getWithFormTags());
+	}
+
+
+	/**
+	 * This generates and returns the form object for the global messages settings.
+	 *
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _generate_global_settings_form()
+	{
+		/** @var EE_Network_Core_Config $network_config */
+		$network_config = EE_Registry::instance()->NET_CFG->core;
+
+		return new EE_Form_Section_Proper(
+			[
+				'name'            => 'global_messages_settings',
+				'html_id'         => 'global_messages_settings',
+				'html_class'      => 'form-table',
+				'layout_strategy' => new EE_Admin_Two_Column_Layout(),
+				'subsections'     => apply_filters(
+					'FHEE__Messages_Admin_Page__global_messages_settings_metabox_content__form_subsections',
+					[
+						'do_messages_on_same_request' => new EE_Select_Input(
+							[
+								true  => esc_html__('On the same request', 'event_espresso'),
+								false => esc_html__('On a separate request', 'event_espresso'),
+							],
+							[
+								'default'         => $network_config->do_messages_on_same_request,
+								'html_label_text' => esc_html__(
+									'Generate and send all messages:',
+									'event_espresso'
+								),
+								'html_help_text'  => esc_html__(
+									'By default the messages system uses a more efficient means of processing messages on separate requests and utilizes the wp-cron scheduling system.  This makes things execute faster for people registering for your events.  However, if the wp-cron system is disabled on your site and there is no alternative in place, then you can change this so messages are always executed on the same request.',
+									'event_espresso'
+								),
+							]
+						),
+						'delete_threshold'            => new EE_Select_Input(
+							[
+								0  => esc_html__('Forever', 'event_espresso'),
+								3  => esc_html__('3 Months', 'event_espresso'),
+								6  => esc_html__('6 Months', 'event_espresso'),
+								9  => esc_html__('9 Months', 'event_espresso'),
+								12 => esc_html__('12 Months', 'event_espresso'),
+								24 => esc_html__('24 Months', 'event_espresso'),
+								36 => esc_html__('36 Months', 'event_espresso'),
+							],
+							[
+								'default'         => EE_Registry::instance()->CFG->messages->delete_threshold,
+								'html_label_text' => esc_html__('Cleanup of old messages:', 'event_espresso'),
+								'html_help_text'  => esc_html__(
+									'You can control how long a record of processed messages is kept via this option.',
+									'event_espresso'
+								),
+							]
+						),
+						'update_settings'             => new EE_Submit_Input(
+							[
+								'default'         => esc_html__('Update', 'event_espresso'),
+								'html_label_text' => '',
+							]
+						),
+					]
+				),
+			]
+		);
+	}
+
+
+	/**
+	 * This handles updating the global settings set on the admin page.
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	protected function _update_global_settings()
+	{
+		/** @var EE_Network_Core_Config $network_config */
+		$network_config  = EE_Registry::instance()->NET_CFG->core;
+		$messages_config = EE_Registry::instance()->CFG->messages;
+		$form            = $this->_generate_global_settings_form();
+		if ($form->was_submitted()) {
+			$form->receive_form_submission();
+			if ($form->is_valid()) {
+				$valid_data = $form->valid_data();
+				foreach ($valid_data as $property => $value) {
+					$setter = 'set_' . $property;
+					if (method_exists($network_config, $setter)) {
+						$network_config->{$setter}($value);
+					} elseif (
+						property_exists($network_config, $property)
+						&& $network_config->{$property} !== $value
+					) {
+						$network_config->{$property} = $value;
+					} elseif (
+						property_exists($messages_config, $property)
+						&& $messages_config->{$property} !== $value
+					) {
+						$messages_config->{$property} = $value;
+					}
+				}
+				// only update if the form submission was valid!
+				EE_Registry::instance()->NET_CFG->update_config(true, false);
+				EE_Registry::instance()->CFG->update_espresso_config();
+				EE_Error::overwrite_success();
+				EE_Error::add_success(esc_html__('Global message settings were updated', 'event_espresso'));
+			}
+		}
+		$this->_redirect_after_action(0, '', '', ['action' => 'settings'], true);
+	}
+
+
+	/**
+	 * this prepares the messenger tabs that can be dragged in and out of messenger boxes to activate/deactivate
+	 *
+	 * @param array $tab_array This is an array of message type tab details used to generate the tabs
+	 * @return string html formatted tabs
+	 * @throws DomainException
+	 */
+	protected function _get_mt_tabs($tab_array)
+	{
+		$tab_array = (array) $tab_array;
+		$template  = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_mt_settings_tab_item.template.php';
+		$tabs      = '';
+
+		foreach ($tab_array as $tab) {
+			$tabs .= EEH_Template::display_template($template, $tab, true);
+		}
+
+		return $tabs;
+	}
+
+
+	/**
+	 * This prepares the content of the messenger meta box admin settings
+	 *
+	 * @param EE_messenger $messenger The messenger we're setting up content for
+	 * @return string html formatted content
+	 * @throws DomainException
+	 */
+	protected function _get_messenger_box_content(EE_messenger $messenger)
+	{
+
+		$fields                                         = $messenger->get_admin_settings_fields();
+		$settings_template_args['template_form_fields'] = '';
+
+		// is $messenger active?
+		$settings_template_args['active'] = $this->_message_resource_manager->is_messenger_active($messenger->name);
+
+
+		if (! empty($fields)) {
+			$existing_settings = $messenger->get_existing_admin_settings();
+
+			foreach ($fields as $fldname => $fldprops) {
+				$field_id                         = $messenger->name . '-' . $fldname;
+				$template_form_field[ $field_id ] = [
+					'name'       => 'messenger_settings[' . $field_id . ']',
+					'label'      => $fldprops['label'],
+					'input'      => $fldprops['field_type'],
+					'type'       => $fldprops['value_type'],
+					'required'   => $fldprops['required'],
+					'validation' => $fldprops['validation'],
+					'value'      => isset($existing_settings[ $field_id ])
+						? $existing_settings[ $field_id ]
+						: $fldprops['default'],
+					'css_class'  => '',
+					'format'     => $fldprops['format'],
+				];
+			}
+
+
+			$settings_template_args['template_form_fields'] = ! empty($template_form_field)
+				? $this->_generate_admin_form_fields($template_form_field, 'string', 'ee_m_activate_form')
+				: '';
+		}
+
+		// we also need some hidden fields
+		$settings_template_args['hidden_fields'] = [
+			'messenger_settings[messenger]' . $messenger->name => [
+				'type'  => 'hidden',
+				'value' => $messenger->name,
+			],
+			'type' . $messenger->name                          => [
+				'type'  => 'hidden',
+				'value' => 'messenger',
+			],
+		];
+
+		// make sure any active message types that are existing are included in the hidden fields
+		if (isset($this->_m_mt_settings['message_type_tabs'][ $messenger->name ]['active'])) {
+			foreach ($this->_m_mt_settings['message_type_tabs'][ $messenger->name ]['active'] as $mt => $values) {
+				$settings_template_args['hidden_fields'][ 'messenger_settings[message_types][' . $mt . ']' ] = [
+					'type'  => 'hidden',
+					'value' => $mt,
+				];
+			}
+		}
+		$settings_template_args['hidden_fields'] = $this->_generate_admin_form_fields(
+			$settings_template_args['hidden_fields'],
+			'array'
+		);
+		$active                                  =
+			$this->_message_resource_manager->is_messenger_active($messenger->name);
+
+		$settings_template_args['messenger']           = $messenger->name;
+		$settings_template_args['description']         = $messenger->description;
+		$settings_template_args['show_hide_edit_form'] = $active ? '' : ' hidden';
+
+
+		$settings_template_args['show_hide_edit_form'] = $this->_message_resource_manager->is_messenger_active(
+			$messenger->name
+		)
+			? $settings_template_args['show_hide_edit_form']
+			: ' hidden';
+
+		$settings_template_args['show_hide_edit_form'] = empty($settings_template_args['template_form_fields'])
+			? ' hidden'
+			: $settings_template_args['show_hide_edit_form'];
+
+
+		$settings_template_args['on_off_action'] = $active ? 'messenger-off' : 'messenger-on';
+		$settings_template_args['nonce']         = wp_create_nonce('activate_' . $messenger->name . '_toggle_nonce');
+		$settings_template_args['on_off_status'] = $active;
+		$template                                = EE_MSG_TEMPLATE_PATH . 'ee_msg_m_settings_content.template.php';
+		return EEH_Template::display_template(
+			$template,
+			$settings_template_args,
+			true
+		);
+	}
+
+
+	/**
+	 * used by ajax on the messages settings page to activate|deactivate the messenger
+	 *
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	public function activate_messenger_toggle()
+	{
+		$success = true;
+		$this->_prep_default_response_for_messenger_or_message_type_toggle();
+		// let's check that we have required data
+
+		if (! $this->_active_messenger_name) {
+			EE_Error::add_error(
+				esc_html__('Messenger name needed to toggle activation. None given', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$success = false;
+		}
+
+		// do a nonce check here since we're not arriving via a normal route
+		$nonce     = $this->request->getRequestParam('activate_nonce', '');
+		$nonce_ref = "activate_{$this->_active_messenger_name}_toggle_nonce";
+
+		$this->_verify_nonce($nonce, $nonce_ref);
+
+
+		$status = $this->request->getRequestParam('status');
+		if (! $status) {
+			EE_Error::add_error(
+				esc_html__(
+					'Messenger status needed to know whether activation or deactivation is happening. No status is given',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$success = false;
+		}
+
+		// do check to verify we have a valid status.
+		if ($status !== 'off' && $status !== 'on') {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__('The given status (%s) is not valid. Must be "off" or "on"', 'event_espresso'),
+					$status
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$success = false;
+		}
+
+		if ($success) {
+			// made it here?  Stop dawdling then!!
+			$success = $status === 'off'
+				? $this->_deactivate_messenger($this->_active_messenger_name)
+				: $this->_activate_messenger($this->_active_messenger_name);
+		}
+
+		$this->_template_args['success'] = $success;
+
+		// no special instructions so let's just do the json return (which should automatically do all the special stuff).
+		$this->_return_json();
+	}
+
+
+	/**
+	 * used by ajax from the messages settings page to activate|deactivate a message type
+	 *
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	public function activate_mt_toggle()
+	{
+		$success = true;
+		$this->_prep_default_response_for_messenger_or_message_type_toggle();
+
+		// let's make sure we have the necessary data
+		if (! $this->_active_message_type_name) {
+			EE_Error::add_error(
+				esc_html__('Message Type name needed to toggle activation. None given', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$success = false;
+		}
+
+		if (! $this->_active_messenger_name) {
+			EE_Error::add_error(
+				esc_html__('Messenger name needed to toggle activation. None given', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$success = false;
+		}
+
+		$status = $this->request->getRequestParam('status');
+		if (! $status) {
+			EE_Error::add_error(
+				esc_html__(
+					'Messenger status needed to know whether activation or deactivation is happening. No status is given',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$success = false;
+		}
+
+
+		// do check to verify we have a valid status.
+		if ($status !== 'activate' && $status !== 'deactivate') {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__('The given status (%s) is not valid. Must be "active" or "inactive"', 'event_espresso'),
+					$status
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$success = false;
+		}
+
+
+		// do a nonce check here since we're not arriving via a normal route
+		$nonce = $this->request->getRequestParam('mt_nonce', '');
+		$this->_verify_nonce($nonce, "{$this->_active_message_type_name}_nonce");
+
+		if ($success) {
+			// made it here? um, what are you waiting for then?
+			$success = $status === 'deactivate'
+				? $this->_deactivate_message_type_for_messenger(
+					$this->_active_messenger_name,
+					$this->_active_message_type_name
+				)
+				: $this->_activate_message_type_for_messenger(
+					$this->_active_messenger_name,
+					$this->_active_message_type_name
+				);
+		}
+
+		$this->_template_args['success'] = $success;
+		$this->_return_json();
+	}
+
+
+	/**
+	 * Takes care of processing activating a messenger and preparing the appropriate response.
+	 *
+	 * @param string $messenger_name The name of the messenger being activated
+	 * @return bool
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _activate_messenger($messenger_name)
+	{
+		$active_messenger          = $this->_message_resource_manager->get_messenger($messenger_name);
+		$message_types_to_activate = $active_messenger instanceof EE_Messenger
+			? $active_messenger->get_default_message_types()
+			: [];
+
+		// ensure is active
+		$this->_message_resource_manager->activate_messenger($active_messenger, $message_types_to_activate);
+
+		// set response_data for reload
+		foreach ($message_types_to_activate as $message_type_name) {
+			$message_type = $this->_message_resource_manager->get_message_type($message_type_name);
+			if (
+				$this->_message_resource_manager->is_message_type_active_for_messenger(
+					$messenger_name,
+					$message_type_name
+				)
+				&& $message_type instanceof EE_message_type
+			) {
+				$this->_template_args['data']['active_mts'][] = $message_type_name;
+				if ($message_type->get_admin_settings_fields()) {
+					$this->_template_args['data']['mt_reload'][] = $message_type_name;
+				}
+			}
+		}
+
+		// add success message for activating messenger
+		return $this->_setup_response_message_for_activating_messenger_with_message_types($active_messenger);
+	}
+
+
+	/**
+	 * Takes care of processing deactivating a messenger and preparing the appropriate response.
+	 *
+	 * @param string $messenger_name The name of the messenger being activated
+	 * @return bool
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _deactivate_messenger($messenger_name)
+	{
+		$active_messenger = $this->_message_resource_manager->get_messenger($messenger_name);
+		$this->_message_resource_manager->deactivate_messenger($messenger_name);
+
+		return $this->_setup_response_message_for_deactivating_messenger_with_message_types($active_messenger);
+	}
+
+
+	/**
+	 * Takes care of processing activating a message type for a messenger and preparing the appropriate response.
+	 *
+	 * @param string $messenger_name    The name of the messenger the message type is being activated for.
+	 * @param string $message_type_name The name of the message type being activated for the messenger
+	 * @return bool
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _activate_message_type_for_messenger($messenger_name, $message_type_name)
+	{
+		$active_messenger         = $this->_message_resource_manager->get_messenger($messenger_name);
+		$message_type_to_activate = $this->_message_resource_manager->get_message_type($message_type_name);
+
+		// ensure is active
+		$this->_message_resource_manager->activate_messenger($active_messenger, $message_type_name);
+
+		// set response for load
+		if (
+			$this->_message_resource_manager->is_message_type_active_for_messenger(
+				$messenger_name,
+				$message_type_name
+			)
+		) {
+			$this->_template_args['data']['active_mts'][] = $message_type_name;
+			if ($message_type_to_activate->get_admin_settings_fields()) {
+				$this->_template_args['data']['mt_reload'][] = $message_type_name;
+			}
+		}
+
+		return $this->_setup_response_message_for_activating_messenger_with_message_types(
+			$active_messenger,
+			$message_type_to_activate
+		);
+	}
+
+
+	/**
+	 * Takes care of processing deactivating a message type for a messenger and preparing the appropriate response.
+	 *
+	 * @param string $messenger_name    The name of the messenger the message type is being deactivated for.
+	 * @param string $message_type_name The name of the message type being deactivated for the messenger
+	 * @return bool
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _deactivate_message_type_for_messenger($messenger_name, $message_type_name)
+	{
+		$active_messenger = $this->_message_resource_manager->get_messenger($messenger_name);
+		/** @var EE_message_type $message_type_to_activate This will be present because it can't be toggled if it isn't */
+		$message_type_to_deactivate = $this->_message_resource_manager->get_message_type($message_type_name);
+		$this->_message_resource_manager->deactivate_message_type_for_messenger($message_type_name, $messenger_name);
+
+		return $this->_setup_response_message_for_deactivating_messenger_with_message_types(
+			$active_messenger,
+			$message_type_to_deactivate
+		);
+	}
+
+
+	/**
+	 * This just initializes the defaults for activating messenger and message type responses.
+	 */
+	protected function _prep_default_response_for_messenger_or_message_type_toggle()
+	{
+		$this->_template_args['data']['active_mts'] = [];
+		$this->_template_args['data']['mt_reload']  = [];
+	}
+
+
+	/**
+	 * Setup appropriate response for activating a messenger and/or message types
+	 *
+	 * @param EE_messenger         $messenger
+	 * @param EE_message_type|null $message_type
+	 * @return bool
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _setup_response_message_for_activating_messenger_with_message_types(
+		$messenger,
+		EE_Message_Type $message_type = null
+	) {
+		// if $messenger isn't a valid messenger object then get out.
+		if (! $messenger instanceof EE_Messenger) {
+			EE_Error::add_error(
+				esc_html__('The messenger being activated is not a valid messenger', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		// activated
+		if ($this->_template_args['data']['active_mts']) {
+			EE_Error::overwrite_success();
+			// activated a message type with the messenger
+			if ($message_type instanceof EE_message_type) {
+				EE_Error::add_success(
+					sprintf(
+						esc_html__(
+							'%s message type has been successfully activated with the %s messenger',
+							'event_espresso'
+						),
+						ucwords($message_type->label['singular']),
+						ucwords($messenger->label['singular'])
+					)
+				);
+
+				// if message type was invoice then let's make sure we activate the invoice payment method.
+				if ($message_type->name === 'invoice') {
+					EE_Registry::instance()->load_lib('Payment_Method_Manager');
+					$pm = EE_Payment_Method_Manager::instance()->activate_a_payment_method_of_type('Invoice');
+					if ($pm instanceof EE_Payment_Method) {
+						EE_Error::add_attention(
+							esc_html__(
+								'Activating the invoice message type also automatically activates the invoice payment method.  If you do not wish the invoice payment method to be active, or to change its settings, visit the payment method admin page.',
+								'event_espresso'
+							)
+						);
+					}
+				}
+				// just toggles the entire messenger
+			} else {
+				EE_Error::add_success(
+					sprintf(
+						esc_html__('%s messenger has been successfully activated', 'event_espresso'),
+						ucwords($messenger->label['singular'])
+					)
+				);
+			}
+
+			return true;
+
+			// possible error condition. This will happen when our active_mts data is empty because it is validated for actual active
+			// message types after the activation process.  However its possible some messengers don't HAVE any default_message_types
+			// in which case we just give a success message for the messenger being successfully activated.
+		} else {
+			if (! $messenger->get_default_message_types()) {
+				// messenger doesn't have any default message types so still a success.
+				EE_Error::add_success(
+					sprintf(
+						esc_html__('%s messenger was successfully activated.', 'event_espresso'),
+						ucwords($messenger->label['singular'])
+					)
+				);
+
+				return true;
+			} else {
+				EE_Error::add_error(
+					$message_type instanceof EE_message_type
+					? sprintf(
+						esc_html__(
+							'%s message type was not successfully activated with the %s messenger',
+							'event_espresso'
+						),
+						ucwords($message_type->label['singular']),
+						ucwords($messenger->label['singular'])
+					)
+					: sprintf(
+						esc_html__('%s messenger was not successfully activated', 'event_espresso'),
+						ucwords($messenger->label['singular'])
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+
+				return false;
+			}
+		}
+	}
+
+
+	/**
+	 * This sets up the appropriate response for deactivating a messenger and/or message type.
+	 *
+	 * @param EE_messenger         $messenger
+	 * @param EE_message_type|null $message_type
+	 * @return bool
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _setup_response_message_for_deactivating_messenger_with_message_types(
+		$messenger,
+		EE_message_type $message_type = null
+	) {
+		EE_Error::overwrite_success();
+
+		// if $messenger isn't a valid messenger object then get out.
+		if (! $messenger instanceof EE_Messenger) {
+			EE_Error::add_error(
+				esc_html__('The messenger being deactivated is not a valid messenger', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+
+			return false;
+		}
+
+		if ($message_type instanceof EE_message_type) {
+			$message_type_name = $message_type->name;
+			EE_Error::add_success(
+				sprintf(
+					esc_html__(
+						'%s message type has been successfully deactivated for the %s messenger.',
+						'event_espresso'
+					),
+					ucwords($message_type->label['singular']),
+					ucwords($messenger->label['singular'])
+				)
+			);
+		} else {
+			$message_type_name = '';
+			EE_Error::add_success(
+				sprintf(
+					esc_html__('%s messenger has been successfully deactivated.', 'event_espresso'),
+					ucwords($messenger->label['singular'])
+				)
+			);
+		}
+
+		// if messenger was html or message type was invoice then let's make sure we deactivate invoice payment method.
+		if (
+			$messenger->name === 'html'
+			&& (
+				is_null($message_type)
+				|| $message_type_name === 'invoice'
+			)
+		) {
+			EE_Registry::instance()->load_lib('Payment_Method_Manager');
+			$count_updated = EE_Payment_Method_Manager::instance()->deactivate_payment_method('invoice');
+			if ($count_updated > 0) {
+				$msg = $message_type_name === 'invoice'
+					? esc_html__(
+						'Deactivating the invoice message type also automatically deactivates the invoice payment method. In order for invoices to be generated the invoice message type must be active. If you completed this action by mistake, simply reactivate the invoice message type and then visit the payment methods admin page to reactivate the invoice payment method.',
+						'event_espresso'
+					)
+					: esc_html__(
+						'Deactivating the html messenger also automatically deactivates the invoice payment method.  In order for invoices to be generated the html messenger must be be active.  If you completed this action by mistake, simply reactivate the html messenger, then visit the payment methods admin page to reactivate the invoice payment method.',
+						'event_espresso'
+					);
+				EE_Error::add_attention($msg);
+			}
+		}
+
+		return true;
+	}
+
+
+	/**
+	 * handles updating a message type form on messenger activation IF the message type has settings fields. (via ajax)
+	 *
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function update_mt_form()
+	{
+		if (! $this->_active_messenger_name || ! $this->_active_message_type_name) {
+			EE_Error::add_error(
+				esc_html__('Require message type or messenger to send an updated form', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$this->_return_json();
+		}
+
+		$message_types = $this->get_installed_message_types();
+		$message_type  = $message_types[ $this->_active_message_type_name ];
+		$messenger     = $this->_message_resource_manager->get_active_messenger($this->_active_messenger_name);
+		$content       = $this->_message_type_settings_content($message_type, $messenger, true);
+
+		$this->_template_args['success'] = true;
+		$this->_template_args['content'] = $content;
+		$this->_return_json();
+	}
+
+
+	/**
+	 * this handles saving the settings for a messenger or message type
+	 *
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function save_settings()
+	{
+		$type = $this->request->getRequestParam('type');
+		if (! $type) {
+			EE_Error::add_error(
+				esc_html__(
+					'Cannot save settings because type is unknown (messenger settings or message type settings?)',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$this->_template_args['error'] = true;
+			$this->_return_json();
+		}
+
+
+		if ($type === 'messenger') {
+			// this should be an array.
+			$settings  = $this->request->getRequestParam('messenger_settings', [], 'string', true);
+			$messenger = $settings['messenger'];
+			// remove messenger and message_types from settings array
+			unset($settings['messenger'], $settings['message_types']);
+			$this->_message_resource_manager->add_settings_for_messenger($messenger, $settings);
+		} elseif ($type === 'message_type') {
+			$settings     = $this->request->getRequestParam('message_type_settings', [], 'string', true);
+			$messenger    = $settings['messenger'];
+			$message_type = $settings['message_type'];
+			// remove messenger and message_types from settings array
+			unset($settings['messenger'], $settings['message_types']);
+			$this->_message_resource_manager->add_settings_for_message_type($messenger, $message_type, $settings);
+		}
+
+		// okay we should have the data all setup.  Now we just update!
+		$success = $this->_message_resource_manager->update_active_messengers_option();
+
+		if ($success) {
+			EE_Error::add_success(esc_html__('Settings updated', 'event_espresso'));
+		} else {
+			EE_Error::add_error(
+				esc_html__('Settings did not get updated', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+
+		$this->_template_args['success'] = $success;
+		$this->_return_json();
+	}
+
+
+
+
+	/**  EE MESSAGE PROCESSING ACTIONS **/
+
+
+	/**
+	 * This immediately generates any EE_Message ID's that are selected that are EEM_Message::status_incomplete
+	 * However, this does not send immediately, it just queues for sending.
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @since 4.9.0
+	 */
+	protected function _generate_now()
+	{
+		EED_Messages::generate_now($this->_get_msg_ids_from_request());
+		$this->_redirect_after_action(false, '', '', [], true);
+	}
+
+
+	/**
+	 * This immediately generates AND sends any EE_Message's selected that are EEM_Message::status_incomplete or that
+	 * are EEM_Message::status_resend or EEM_Message::status_idle
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @since 4.9.0
+	 */
+	protected function _generate_and_send_now()
+	{
+		EED_Messages::generate_and_send_now($this->_get_msg_ids_from_request());
+		$this->_redirect_after_action(false, '', '', [], true);
+	}
+
+
+	/**
+	 * This queues any EEM_Message::status_sent EE_Message ids in the request for resending.
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @since 4.9.0
+	 */
+	protected function _queue_for_resending()
+	{
+		EED_Messages::queue_for_resending($this->_get_msg_ids_from_request());
+		$this->_redirect_after_action(false, '', '', [], true);
+	}
+
+
+	/**
+	 *  This sends immediately any EEM_Message::status_idle or EEM_Message::status_resend messages in the queue
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @since 4.9.0
+	 */
+	protected function _send_now()
+	{
+		EED_Messages::send_now($this->_get_msg_ids_from_request());
+		$this->_redirect_after_action(false, '', '', [], true);
+	}
+
+
+	/**
+	 * Deletes EE_messages for IDs in the request.
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @since 4.9.0
+	 */
+	protected function _delete_ee_messages()
+	{
+		$MSG_IDs       = $this->_get_msg_ids_from_request();
+		$deleted_count = 0;
+		foreach ($MSG_IDs as $MSG_ID) {
+			if ($this->getMsgModel()->delete_by_ID($MSG_ID)) {
+				$deleted_count++;
+			}
+		}
+		if ($deleted_count) {
+			EE_Error::add_success(
+				esc_html(
+					_n(
+						'Message successfully deleted',
+						'Messages successfully deleted',
+						$deleted_count,
+						'event_espresso'
+					)
+				)
+			);
+		} else {
+			EE_Error::add_error(
+				_n('The message was not deleted.', 'The messages were not deleted', count($MSG_IDs), 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		$this->_redirect_after_action(false, '', '', [], true);
+	}
+
+
+	/**
+	 *  This looks for 'MSG_ID' key in the request and returns an array of MSG_ID's if present.
+	 *
+	 * @return array
+	 * @since 4.9.0
+	 */
+	protected function _get_msg_ids_from_request()
+	{
+		$MSG_IDs = $this->request->getRequestParam('MSG_ID', [], 'string', true);
+		if (empty($MSG_IDs)) {
+			return [];
+		}
+		// if 'MSG_ID' was just a single ID (not an array)
+		// then $MSG_IDs will be something like [123] so $MSG_IDs[0] should be 123
+		// otherwise, $MSG_IDs was already an array where message IDs were used as the keys
+		return count($MSG_IDs) === 1 && isset($MSG_IDs[0])
+			? $MSG_IDs
+			: array_keys($MSG_IDs);
+	}
 }

admin_pages/registrations/Registrations_Admin_Page.core.php

Indentation +3653 added lines, -3653 removed lines

@@ -20,2209 +20,2209 @@ 
  */
 class Registrations_Admin_Page extends EE_Admin_Page_CPT
 {
-    /**
-     * @var EE_Registration
-     */
-    private $_registration;
-
-    /**
-     * @var EE_Event
-     */
-    private $_reg_event;
-
-    /**
-     * @var EE_Session
-     */
-    private $_session;
-
-    /**
-     * @var array
-     */
-    private static $_reg_status;
-
-    /**
-     * Form for displaying the custom questions for this registration.
-     * This gets used a few times throughout the request so its best to cache it
-     *
-     * @var EE_Registration_Custom_Questions_Form
-     */
-    protected $_reg_custom_questions_form;
-
-    /**
-     * @var EEM_Registration $registration_model
-     */
-    private $registration_model;
-
-    /**
-     * @var EEM_Attendee $attendee_model
-     */
-    private $attendee_model;
-
-    /**
-     * @var EEM_Event $event_model
-     */
-    private $event_model;
-
-    /**
-     * @var EEM_Status $status_model
-     */
-    private $status_model;
-
-
-    /**
-     * @param bool $routing
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function __construct($routing = true)
-    {
-        parent::__construct($routing);
-        add_action('wp_loaded', [$this, 'wp_loaded']);
-    }
-
-
-    /**
-     * @return EEM_Registration
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @since 4.10.2.p
-     */
-    protected function getRegistrationModel()
-    {
-        if (! $this->registration_model instanceof EEM_Registration) {
-            $this->registration_model = $this->loader->getShared('EEM_Registration');
-        }
-        return $this->registration_model;
-    }
-
-
-    /**
-     * @return EEM_Attendee
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @since 4.10.2.p
-     */
-    protected function getAttendeeModel()
-    {
-        if (! $this->attendee_model instanceof EEM_Attendee) {
-            $this->attendee_model = $this->loader->getShared('EEM_Attendee');
-        }
-        return $this->attendee_model;
-    }
-
-
-    /**
-     * @return EEM_Event
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @since 4.10.2.p
-     */
-    protected function getEventModel()
-    {
-        if (! $this->event_model instanceof EEM_Event) {
-            $this->event_model = $this->loader->getShared('EEM_Event');
-        }
-        return $this->event_model;
-    }
-
-
-    /**
-     * @return EEM_Status
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @since 4.10.2.p
-     */
-    protected function getStatusModel()
-    {
-        if (! $this->status_model instanceof EEM_Status) {
-            $this->status_model = $this->loader->getShared('EEM_Status');
-        }
-        return $this->status_model;
-    }
-
-
-    public function wp_loaded()
-    {
-        // when adding a new registration...
-        $action = $this->request->getRequestParam('action');
-        if ($action === 'new_registration') {
-            EE_System::do_not_cache();
-            if ($this->request->getRequestParam('processing_registration', 0, 'int') !== 1) {
-                // and it's NOT the attendee information reg step
-                // force cookie expiration by setting time to last week
-                setcookie('ee_registration_added', 0, time() - WEEK_IN_SECONDS, '/');
-                // and update the global
-                $_COOKIE['ee_registration_added'] = 0;
-            }
-        }
-    }
-
-
-    protected function _init_page_props()
-    {
-        $this->page_slug        = REG_PG_SLUG;
-        $this->_admin_base_url  = REG_ADMIN_URL;
-        $this->_admin_base_path = REG_ADMIN;
-        $this->page_label       = esc_html__('Registrations', 'event_espresso');
-        $this->_cpt_routes      = [
-            'add_new_attendee' => 'espresso_attendees',
-            'edit_attendee'    => 'espresso_attendees',
-            'insert_attendee'  => 'espresso_attendees',
-            'update_attendee'  => 'espresso_attendees',
-        ];
-        $this->_cpt_model_names = [
-            'add_new_attendee' => 'EEM_Attendee',
-            'edit_attendee'    => 'EEM_Attendee',
-        ];
-        $this->_cpt_edit_routes = [
-            'espresso_attendees' => 'edit_attendee',
-        ];
-        $this->_pagenow_map     = [
-            'add_new_attendee' => 'post-new.php',
-            'edit_attendee'    => 'post.php',
-            'trash'            => 'post.php',
-        ];
-        add_action('edit_form_after_title', [$this, 'after_title_form_fields'], 10);
-        // add filters so that the comment urls don't take users to a confusing 404 page
-        add_filter('get_comment_link', [$this, 'clear_comment_link'], 10, 2);
-    }
-
-
-    /**
-     * @param string     $link    The comment permalink with '#comment-$id' appended.
-     * @param WP_Comment $comment The current comment object.
-     * @return string
-     */
-    public function clear_comment_link($link, WP_Comment $comment)
-    {
-        // gotta make sure this only happens on this route
-        $post_type = get_post_type($comment->comment_post_ID);
-        if ($post_type === 'espresso_attendees') {
-            return '#commentsdiv';
-        }
-        return $link;
-    }
-
-
-    protected function _ajax_hooks()
-    {
-        // todo: all hooks for registrations ajax goes in here
-        add_action('wp_ajax_toggle_checkin_status', [$this, 'toggle_checkin_status']);
-    }
-
-
-    protected function _define_page_props()
-    {
-        $this->_admin_page_title = $this->page_label;
-        $this->_labels           = [
-            'buttons'                      => [
-                'add-registrant'      => esc_html__('Add New Registration', 'event_espresso'),
-                'add-attendee'        => esc_html__('Add Contact', 'event_espresso'),
-                'edit'                => esc_html__('Edit Contact', 'event_espresso'),
-                'report'              => esc_html__('Event Registrations CSV Report', 'event_espresso'),
-                'report_datetime'     => esc_html__('Datetime Registrations CSV Report', 'event_espresso'),
-                'report_all'          => esc_html__('All Registrations CSV Report', 'event_espresso'),
-                'report_filtered'     => esc_html__('Filtered CSV Report', 'event_espresso'),
-                'contact_list_report' => esc_html__('Contact List Report', 'event_espresso'),
-                'contact_list_export' => esc_html__('Export Data', 'event_espresso'),
-            ],
-            'publishbox'                   => [
-                'add_new_attendee' => esc_html__('Add Contact Record', 'event_espresso'),
-                'edit_attendee'    => esc_html__('Update Contact Record', 'event_espresso'),
-            ],
-            'hide_add_button_on_cpt_route' => [
-                'edit_attendee' => true,
-            ],
-        ];
-    }
-
-
-    /**
-     * grab url requests and route them
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function _set_page_routes()
-    {
-        $this->_get_registration_status_array();
-        $REG_ID             = $this->request->getRequestParam('_REG_ID', 0, 'int');
-        $REG_ID             = $this->request->getRequestParam('reg_status_change_form[REG_ID]', $REG_ID, 'int');
-        $ATT_ID             = $this->request->getRequestParam('ATT_ID', 0, 'int');
-        $ATT_ID             = $this->request->getRequestParam('post', $ATT_ID, 'int');
-        $this->_page_routes = [
-            'default'                             => [
-                'func'       => '_registrations_overview_list_table',
-                'capability' => 'ee_read_registrations',
-            ],
-            'view_registration'                   => [
-                'func'       => '_registration_details',
-                'capability' => 'ee_read_registration',
-                'obj_id'     => $REG_ID,
-            ],
-            'edit_registration'                   => [
-                'func'               => '_update_attendee_registration_form',
-                'noheader'           => true,
-                'headers_sent_route' => 'view_registration',
-                'capability'         => 'ee_edit_registration',
-                'obj_id'             => $REG_ID,
-                '_REG_ID'            => $REG_ID,
-            ],
-            'trash_registrations'                 => [
-                'func'       => '_trash_or_restore_registrations',
-                'args'       => ['trash' => true],
-                'noheader'   => true,
-                'capability' => 'ee_delete_registrations',
-            ],
-            'restore_registrations'               => [
-                'func'       => '_trash_or_restore_registrations',
-                'args'       => ['trash' => false],
-                'noheader'   => true,
-                'capability' => 'ee_delete_registrations',
-            ],
-            'delete_registrations'                => [
-                'func'       => '_delete_registrations',
-                'noheader'   => true,
-                'capability' => 'ee_delete_registrations',
-            ],
-            'new_registration'                    => [
-                'func'       => 'new_registration',
-                'capability' => 'ee_edit_registrations',
-            ],
-            'process_reg_step'                    => [
-                'func'       => 'process_reg_step',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registrations',
-            ],
-            'redirect_to_txn'                     => [
-                'func'       => 'redirect_to_txn',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registrations',
-            ],
-            'change_reg_status'                   => [
-                'func'       => '_change_reg_status',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $REG_ID,
-            ],
-            'approve_registration'                => [
-                'func'       => 'approve_registration',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $REG_ID,
-            ],
-            'approve_and_notify_registration'     => [
-                'func'       => 'approve_registration',
-                'noheader'   => true,
-                'args'       => [true],
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $REG_ID,
-            ],
-            'approve_registrations'               => [
-                'func'       => 'bulk_action_on_registrations',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registrations',
-                'args'       => ['approve'],
-            ],
-            'approve_and_notify_registrations'    => [
-                'func'       => 'bulk_action_on_registrations',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registrations',
-                'args'       => ['approve', true],
-            ],
-            'decline_registration'                => [
-                'func'       => 'decline_registration',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $REG_ID,
-            ],
-            'decline_and_notify_registration'     => [
-                'func'       => 'decline_registration',
-                'noheader'   => true,
-                'args'       => [true],
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $REG_ID,
-            ],
-            'decline_registrations'               => [
-                'func'       => 'bulk_action_on_registrations',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registrations',
-                'args'       => ['decline'],
-            ],
-            'decline_and_notify_registrations'    => [
-                'func'       => 'bulk_action_on_registrations',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registrations',
-                'args'       => ['decline', true],
-            ],
-            'pending_registration'                => [
-                'func'       => 'pending_registration',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $REG_ID,
-            ],
-            'pending_and_notify_registration'     => [
-                'func'       => 'pending_registration',
-                'noheader'   => true,
-                'args'       => [true],
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $REG_ID,
-            ],
-            'pending_registrations'               => [
-                'func'       => 'bulk_action_on_registrations',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registrations',
-                'args'       => ['pending'],
-            ],
-            'pending_and_notify_registrations'    => [
-                'func'       => 'bulk_action_on_registrations',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registrations',
-                'args'       => ['pending', true],
-            ],
-            'no_approve_registration'             => [
-                'func'       => 'not_approve_registration',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $REG_ID,
-            ],
-            'no_approve_and_notify_registration'  => [
-                'func'       => 'not_approve_registration',
-                'noheader'   => true,
-                'args'       => [true],
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $REG_ID,
-            ],
-            'no_approve_registrations'            => [
-                'func'       => 'bulk_action_on_registrations',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registrations',
-                'args'       => ['not_approve'],
-            ],
-            'no_approve_and_notify_registrations' => [
-                'func'       => 'bulk_action_on_registrations',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registrations',
-                'args'       => ['not_approve', true],
-            ],
-            'cancel_registration'                 => [
-                'func'       => 'cancel_registration',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $REG_ID,
-            ],
-            'cancel_and_notify_registration'      => [
-                'func'       => 'cancel_registration',
-                'noheader'   => true,
-                'args'       => [true],
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $REG_ID,
-            ],
-            'cancel_registrations'                => [
-                'func'       => 'bulk_action_on_registrations',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registrations',
-                'args'       => ['cancel'],
-            ],
-            'cancel_and_notify_registrations'     => [
-                'func'       => 'bulk_action_on_registrations',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registrations',
-                'args'       => ['cancel', true],
-            ],
-            'wait_list_registration'              => [
-                'func'       => 'wait_list_registration',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $REG_ID,
-            ],
-            'wait_list_and_notify_registration'   => [
-                'func'       => 'wait_list_registration',
-                'noheader'   => true,
-                'args'       => [true],
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $REG_ID,
-            ],
-            'contact_list'                        => [
-                'func'       => '_attendee_contact_list_table',
-                'capability' => 'ee_read_contacts',
-            ],
-            'add_new_attendee'                    => [
-                'func' => '_create_new_cpt_item',
-                'args' => [
-                    'new_attendee' => true,
-                    'capability'   => 'ee_edit_contacts',
-                ],
-            ],
-            'edit_attendee'                       => [
-                'func'       => '_edit_cpt_item',
-                'capability' => 'ee_edit_contacts',
-                'obj_id'     => $ATT_ID,
-            ],
-            'duplicate_attendee'                  => [
-                'func'       => '_duplicate_attendee',
-                'noheader'   => true,
-                'capability' => 'ee_edit_contacts',
-                'obj_id'     => $ATT_ID,
-            ],
-            'insert_attendee'                     => [
-                'func'       => '_insert_or_update_attendee',
-                'args'       => [
-                    'new_attendee' => true,
-                ],
-                'noheader'   => true,
-                'capability' => 'ee_edit_contacts',
-            ],
-            'update_attendee'                     => [
-                'func'       => '_insert_or_update_attendee',
-                'args'       => [
-                    'new_attendee' => false,
-                ],
-                'noheader'   => true,
-                'capability' => 'ee_edit_contacts',
-                'obj_id'     => $ATT_ID,
-            ],
-            'trash_attendees'                     => [
-                'func'       => '_trash_or_restore_attendees',
-                'args'       => [
-                    'trash' => 'true',
-                ],
-                'noheader'   => true,
-                'capability' => 'ee_delete_contacts',
-            ],
-            'trash_attendee'                      => [
-                'func'       => '_trash_or_restore_attendees',
-                'args'       => [
-                    'trash' => true,
-                ],
-                'noheader'   => true,
-                'capability' => 'ee_delete_contacts',
-                'obj_id'     => $ATT_ID,
-            ],
-            'restore_attendees'                   => [
-                'func'       => '_trash_or_restore_attendees',
-                'args'       => [
-                    'trash' => false,
-                ],
-                'noheader'   => true,
-                'capability' => 'ee_delete_contacts',
-                'obj_id'     => $ATT_ID,
-            ],
-            'resend_registration'                 => [
-                'func'       => '_resend_registration',
-                'noheader'   => true,
-                'capability' => 'ee_send_message',
-            ],
-            'registrations_report'                => [
-                'func'       => '_registrations_report',
-                'noheader'   => true,
-                'capability' => 'ee_read_registrations',
-            ],
-            'contact_list_export'                 => [
-                'func'       => '_contact_list_export',
-                'noheader'   => true,
-                'capability' => 'export',
-            ],
-            'contact_list_report'                 => [
-                'func'       => '_contact_list_report',
-                'noheader'   => true,
-                'capability' => 'ee_read_contacts',
-            ],
-        ];
-    }
-
-
-    protected function _set_page_config()
-    {
-        $REG_ID             = $this->request->getRequestParam('_REG_ID', 0, 'int');
-        $ATT_ID             = $this->request->getRequestParam('ATT_ID', 0, 'int');
-        $this->_page_config = [
-            'default'           => [
-                'nav'           => [
-                    'label' => esc_html__('Overview', 'event_espresso'),
-                    'icon' => 'dashicons-list-view',
-                    'order' => 5,
-                ],
-                'help_tabs'     => [
-                    'registrations_overview_help_tab'                       => [
-                        'title'    => esc_html__('Registrations Overview', 'event_espresso'),
-                        'filename' => 'registrations_overview',
-                    ],
-                    'registrations_overview_table_column_headings_help_tab' => [
-                        'title'    => esc_html__('Registrations Table Column Headings', 'event_espresso'),
-                        'filename' => 'registrations_overview_table_column_headings',
-                    ],
-                    'registrations_overview_filters_help_tab'               => [
-                        'title'    => esc_html__('Registration Filters', 'event_espresso'),
-                        'filename' => 'registrations_overview_filters',
-                    ],
-                    'registrations_overview_views_help_tab'                 => [
-                        'title'    => esc_html__('Registration Views', 'event_espresso'),
-                        'filename' => 'registrations_overview_views',
-                    ],
-                    'registrations_regoverview_other_help_tab'              => [
-                        'title'    => esc_html__('Registrations Other', 'event_espresso'),
-                        'filename' => 'registrations_overview_other',
-                    ],
-                ],
-                'list_table'    => 'EE_Registrations_List_Table',
-                'require_nonce' => false,
-            ],
-            'view_registration' => [
-                'nav'           => [
-                    'label'      => esc_html__('REG Details', 'event_espresso'),
-                    'icon' => 'dashicons-clipboard',
-                    'order'      => 15,
-                    'url'        => $REG_ID
-                        ? add_query_arg(['_REG_ID' => $REG_ID], $this->_current_page_view_url)
-                        : $this->_admin_base_url,
-                    'persistent' => false,
-                ],
-                'help_tabs'     => [
-                    'registrations_details_help_tab'                    => [
-                        'title'    => esc_html__('Registration Details', 'event_espresso'),
-                        'filename' => 'registrations_details',
-                    ],
-                    'registrations_details_table_help_tab'              => [
-                        'title'    => esc_html__('Registration Details Table', 'event_espresso'),
-                        'filename' => 'registrations_details_table',
-                    ],
-                    'registrations_details_form_answers_help_tab'       => [
-                        'title'    => esc_html__('Registration Form Answers', 'event_espresso'),
-                        'filename' => 'registrations_details_form_answers',
-                    ],
-                    'registrations_details_registrant_details_help_tab' => [
-                        'title'    => esc_html__('Contact Details', 'event_espresso'),
-                        'filename' => 'registrations_details_registrant_details',
-                    ],
-                ],
-                'metaboxes'     => array_merge(
-                    $this->_default_espresso_metaboxes,
-                    ['_registration_details_metaboxes']
-                ),
-                'require_nonce' => false,
-            ],
-            'new_registration'  => [
-                'nav'           => [
-                    'label'      => esc_html__('Add New Registration', 'event_espresso'),
-                    'icon' => 'dashicons-plus-alt',
-                    'url'        => '#',
-                    'order'      => 15,
-                    'persistent' => false,
-                ],
-                'metaboxes'     => $this->_default_espresso_metaboxes,
-                'labels'        => [
-                    'publishbox' => esc_html__('Save Registration', 'event_espresso'),
-                ],
-                'require_nonce' => false,
-            ],
-            'add_new_attendee'  => [
-                'nav'           => [
-                    'label'      => esc_html__('Add Contact', 'event_espresso'),
-                    'icon' => 'dashicons-plus-alt',
-                    'order'      => 15,
-                    'persistent' => false,
-                ],
-                'metaboxes'     => array_merge(
-                    $this->_default_espresso_metaboxes,
-                    ['_publish_post_box', 'attendee_editor_metaboxes']
-                ),
-                'require_nonce' => false,
-            ],
-            'edit_attendee'     => [
-                'nav'           => [
-                    'label'      => esc_html__('Edit Contact', 'event_espresso'),
-                    'icon' => 'dashicons-edit-large',
-                    'order'      => 15,
-                    'persistent' => false,
-                    'url'        => $ATT_ID
-                        ? add_query_arg(['ATT_ID' => $ATT_ID], $this->_current_page_view_url)
-                        : $this->_admin_base_url,
-                ],
-                'metaboxes'     => array_merge(
-                    $this->_default_espresso_metaboxes,
-                    ['attendee_editor_metaboxes']
-                ),
-                'require_nonce' => false,
-            ],
-            'contact_list'      => [
-                'nav'           => [
-                    'label' => esc_html__('Contact List', 'event_espresso'),
-                    'icon' => 'dashicons-id-alt',
-                    'order' => 20,
-                ],
-                'list_table'    => 'EE_Attendee_Contact_List_Table',
-                'help_tabs'     => [
-                    'registrations_contact_list_help_tab'                       => [
-                        'title'    => esc_html__('Registrations Contact List', 'event_espresso'),
-                        'filename' => 'registrations_contact_list',
-                    ],
-                    'registrations_contact-list_table_column_headings_help_tab' => [
-                        'title'    => esc_html__('Contact List Table Column Headings', 'event_espresso'),
-                        'filename' => 'registrations_contact_list_table_column_headings',
-                    ],
-                    'registrations_contact_list_views_help_tab'                 => [
-                        'title'    => esc_html__('Contact List Views', 'event_espresso'),
-                        'filename' => 'registrations_contact_list_views',
-                    ],
-                    'registrations_contact_list_other_help_tab'                 => [
-                        'title'    => esc_html__('Contact List Other', 'event_espresso'),
-                        'filename' => 'registrations_contact_list_other',
-                    ],
-                ],
-                'metaboxes'     => [],
-                'require_nonce' => false,
-            ],
-            // override default cpt routes
-            'create_new'        => '',
-            'edit'              => '',
-        ];
-    }
-
-
-    /**
-     * The below methods aren't used by this class currently
-     */
-    protected function _add_screen_options()
-    {
-    }
-
-
-    protected function _add_feature_pointers()
-    {
-    }
-
-
-    public function admin_init()
-    {
-        EE_Registry::$i18n_js_strings['update_att_qstns'] = esc_html__(
-            'click "Update Registration Questions" to save your changes',
-            'event_espresso'
-        );
-    }
-
-
-    public function admin_notices()
-    {
-    }
-
-
-    public function admin_footer_scripts()
-    {
-    }
-
-
-    /**
-     * get list of registration statuses
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    private function _get_registration_status_array()
-    {
-        self::$_reg_status = EEM_Registration::reg_status_array([], true);
-    }
-
-
-    /**
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @since 4.10.2.p
-     */
-    protected function _add_screen_options_default()
-    {
-        $this->_per_page_screen_option();
-    }
-
-
-    /**
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @since 4.10.2.p
-     */
-    protected function _add_screen_options_contact_list()
-    {
-        $page_title              = $this->_admin_page_title;
-        $this->_admin_page_title = esc_html__('Contacts', 'event_espresso');
-        $this->_per_page_screen_option();
-        $this->_admin_page_title = $page_title;
-    }
-
-
-    public function load_scripts_styles()
-    {
-        // style
-        wp_register_style(
-            'espresso_reg',
-            REG_ASSETS_URL . 'espresso_registrations_admin.css',
-            ['ee-admin-css'],
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('espresso_reg');
-        // script
-        wp_register_script(
-            'espresso_reg',
-            REG_ASSETS_URL . 'espresso_registrations_admin.js',
-            ['jquery-ui-datepicker', 'jquery-ui-draggable', 'ee_admin_js'],
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_enqueue_script('espresso_reg');
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @since 4.10.2.p
-     */
-    public function load_scripts_styles_edit_attendee()
-    {
-        // stuff to only show up on our attendee edit details page.
-        $attendee_details_translations = [
-            'att_publish_text' => sprintf(
-            /* translators: The date and time */
-                wp_strip_all_tags(__('Created on: %s', 'event_espresso')),
-                '<b>' . $this->_cpt_model_obj->get_datetime('ATT_created') . '</b>'
-            ),
-        ];
-        wp_localize_script('espresso_reg', 'ATTENDEE_DETAILS', $attendee_details_translations);
-        wp_enqueue_script('jquery-validate');
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @since 4.10.2.p
-     */
-    public function load_scripts_styles_view_registration()
-    {
-        // styles
-        wp_enqueue_style('espresso-ui-theme');
-        // scripts
-        $this->_get_reg_custom_questions_form($this->_registration->ID());
-        $this->_reg_custom_questions_form->wp_enqueue_scripts();
-    }
-
-
-    public function load_scripts_styles_contact_list()
-    {
-        wp_dequeue_style('espresso_reg');
-        wp_register_style(
-            'espresso_att',
-            REG_ASSETS_URL . 'espresso_attendees_admin.css',
-            ['ee-admin-css'],
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('espresso_att');
-    }
-
-
-    public function load_scripts_styles_new_registration()
-    {
-        wp_register_script(
-            'ee-spco-for-admin',
-            REG_ASSETS_URL . 'spco_for_admin.js',
-            ['underscore', 'jquery'],
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_enqueue_script('ee-spco-for-admin');
-        add_filter('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true');
-        EE_Form_Section_Proper::wp_enqueue_scripts();
-        EED_Ticket_Selector::load_tckt_slctr_assets();
-        EE_Datepicker_Input::enqueue_styles_and_scripts();
-    }
-
-
-    public function AHEE__EE_Admin_Page__route_admin_request_resend_registration()
-    {
-        add_filter('FHEE_load_EE_messages', '__return_true');
-    }
-
-
-    public function AHEE__EE_Admin_Page__route_admin_request_approve_registration()
-    {
-        add_filter('FHEE_load_EE_messages', '__return_true');
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @since 4.10.2.p
-     */
-    protected function _set_list_table_views_default()
-    {
-        // for notification related bulk actions we need to make sure only active messengers have an option.
-        EED_Messages::set_autoloaders();
-        /** @type EE_Message_Resource_Manager $message_resource_manager */
-        $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        $active_mts               = $message_resource_manager->list_of_active_message_types();
-        // key= bulk_action_slug, value= message type.
-        $match_array = [
-            'approve_registrations'    => 'registration',
-            'decline_registrations'    => 'declined_registration',
-            'pending_registrations'    => 'pending_approval',
-            'no_approve_registrations' => 'not_approved_registration',
-            'cancel_registrations'     => 'cancelled_registration',
-        ];
-        $can_send    = EE_Registry::instance()->CAP->current_user_can(
-            'ee_send_message',
-            'batch_send_messages'
-        );
-        /** setup reg status bulk actions **/
-        $def_reg_status_actions['approve_registrations'] = esc_html__('Approve Registrations', 'event_espresso');
-        if ($can_send && in_array($match_array['approve_registrations'], $active_mts, true)) {
-            $def_reg_status_actions['approve_and_notify_registrations'] = esc_html__(
-                'Approve and Notify Registrations',
-                'event_espresso'
-            );
-        }
-        $def_reg_status_actions['decline_registrations'] = esc_html__('Decline Registrations', 'event_espresso');
-        if ($can_send && in_array($match_array['decline_registrations'], $active_mts, true)) {
-            $def_reg_status_actions['decline_and_notify_registrations'] = esc_html__(
-                'Decline and Notify Registrations',
-                'event_espresso'
-            );
-        }
-        $def_reg_status_actions['pending_registrations'] = esc_html__(
-            'Set Registrations to Pending Payment',
-            'event_espresso'
-        );
-        if ($can_send && in_array($match_array['pending_registrations'], $active_mts, true)) {
-            $def_reg_status_actions['pending_and_notify_registrations'] = esc_html__(
-                'Set Registrations to Pending Payment and Notify',
-                'event_espresso'
-            );
-        }
-        $def_reg_status_actions['no_approve_registrations'] = esc_html__(
-            'Set Registrations to Not Approved',
-            'event_espresso'
-        );
-        if ($can_send && in_array($match_array['no_approve_registrations'], $active_mts, true)) {
-            $def_reg_status_actions['no_approve_and_notify_registrations'] = esc_html__(
-                'Set Registrations to Not Approved and Notify',
-                'event_espresso'
-            );
-        }
-        $def_reg_status_actions['cancel_registrations'] = esc_html__('Cancel Registrations', 'event_espresso');
-        if ($can_send && in_array($match_array['cancel_registrations'], $active_mts, true)) {
-            $def_reg_status_actions['cancel_and_notify_registrations'] = esc_html__(
-                'Cancel Registrations and Notify',
-                'event_espresso'
-            );
-        }
-        $def_reg_status_actions = apply_filters(
-            'FHEE__Registrations_Admin_Page___set_list_table_views_default__def_reg_status_actions_array',
-            $def_reg_status_actions,
-            $active_mts,
-            $can_send
-        );
-
-        $this->_views = [
-            'all'   => [
-                'slug'        => 'all',
-                'label'       => esc_html__('View All Registrations', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array_merge(
-                    $def_reg_status_actions,
-                    [
-                        'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'),
-                    ]
-                ),
-            ],
-            'month' => [
-                'slug'        => 'month',
-                'label'       => esc_html__('This Month', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array_merge(
-                    $def_reg_status_actions,
-                    [
-                        'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'),
-                    ]
-                ),
-            ],
-            'today' => [
-                'slug'        => 'today',
-                'label'       => sprintf(
-                    esc_html__('Today - %s', 'event_espresso'),
-                    date('M d, Y', current_time('timestamp'))
-                ),
-                'count'       => 0,
-                'bulk_action' => array_merge(
-                    $def_reg_status_actions,
-                    [
-                        'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'),
-                    ]
-                ),
-            ],
-        ];
-        if (
-            EE_Registry::instance()->CAP->current_user_can(
-                'ee_delete_registrations',
-                'espresso_registrations_delete_registration'
-            )
-        ) {
-            $this->_views['incomplete'] = [
-                'slug'        => 'incomplete',
-                'label'       => esc_html__('Incomplete', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => [
-                    'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'),
-                ],
-            ];
-            $this->_views['trash']      = [
-                'slug'        => 'trash',
-                'label'       => esc_html__('Trash', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => [
-                    'restore_registrations' => esc_html__('Restore Registrations', 'event_espresso'),
-                    'delete_registrations'  => esc_html__('Delete Registrations Permanently', 'event_espresso'),
-                ],
-            ];
-        }
-    }
-
-
-    protected function _set_list_table_views_contact_list()
-    {
-        $this->_views = [
-            'in_use' => [
-                'slug'        => 'in_use',
-                'label'       => esc_html__('In Use', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => [
-                    'trash_attendees' => esc_html__('Move to Trash', 'event_espresso'),
-                ],
-            ],
-        ];
-        if (
-            EE_Registry::instance()->CAP->current_user_can(
-                'ee_delete_contacts',
-                'espresso_registrations_trash_attendees'
-            )
-        ) {
-            $this->_views['trash'] = [
-                'slug'        => 'trash',
-                'label'       => esc_html__('Trash', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => [
-                    'restore_attendees' => esc_html__('Restore from Trash', 'event_espresso'),
-                ],
-            ];
-        }
-    }
-
-
-    /**
-     * @return array
-     * @throws EE_Error
-     */
-    protected function _registration_legend_items()
-    {
-        $fc_items = [
-            'star-icon'        => [
-                'class' => 'dashicons dashicons-star-filled gold-icon',
-                'desc'  => esc_html__('This is the Primary Registrant', 'event_espresso'),
-            ],
-            'view_details'     => [
-                'class' => 'dashicons dashicons-clipboard',
-                'desc'  => esc_html__('View Registration Details', 'event_espresso'),
-            ],
-            'edit_attendee'    => [
-                'class' => 'dashicons dashicons-admin-users',
-                'desc'  => esc_html__('Edit Contact Details', 'event_espresso'),
-            ],
-            'view_transaction' => [
-                'class' => 'dashicons dashicons-cart',
-                'desc'  => esc_html__('View Transaction Details', 'event_espresso'),
-            ],
-            'view_invoice'     => [
-                'class' => 'dashicons dashicons-media-spreadsheet',
-                'desc'  => esc_html__('View Transaction Invoice', 'event_espresso'),
-            ],
-        ];
-        if (
-            EE_Registry::instance()->CAP->current_user_can(
-                'ee_send_message',
-                'espresso_registrations_resend_registration'
-            )
-        ) {
-            $fc_items['resend_registration'] = [
-                'class' => 'dashicons dashicons-email-alt',
-                'desc'  => esc_html__('Resend Registration Details', 'event_espresso'),
-            ];
-        } else {
-            $fc_items['blank'] = ['class' => 'blank', 'desc' => ''];
-        }
-        if (
-            EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_global_messages',
-                'view_filtered_messages'
-            )
-        ) {
-            $related_for_icon = EEH_MSG_Template::get_message_action_icon('see_notifications_for');
-            if (is_array($related_for_icon) && isset($related_for_icon['css_class'], $related_for_icon['label'])) {
-                $fc_items['view_related_messages'] = [
-                    'class' => $related_for_icon['css_class'],
-                    'desc'  => $related_for_icon['label'],
-                ];
-            }
-        }
-        $sc_items = [
-            'approved_status'   => [
-                'class' => 'ee-status-legend ee-status-bg--' . EEM_Registration::status_id_approved,
-                'desc'  => EEH_Template::pretty_status(
-                    EEM_Registration::status_id_approved,
-                    false,
-                    'sentence'
-                ),
-            ],
-            'pending_status'    => [
-                'class' => 'ee-status-legend ee-status-bg--' . EEM_Registration::status_id_pending_payment,
-                'desc'  => EEH_Template::pretty_status(
-                    EEM_Registration::status_id_pending_payment,
-                    false,
-                    'sentence'
-                ),
-            ],
-            'wait_list'         => [
-                'class' => 'ee-status-legend ee-status-bg--' . EEM_Registration::status_id_wait_list,
-                'desc'  => EEH_Template::pretty_status(
-                    EEM_Registration::status_id_wait_list,
-                    false,
-                    'sentence'
-                ),
-            ],
-            'incomplete_status' => [
-                'class' => 'ee-status-legend ee-status-bg--' . EEM_Registration::status_id_incomplete,
-                'desc'  => EEH_Template::pretty_status(
-                    EEM_Registration::status_id_incomplete,
-                    false,
-                    'sentence'
-                ),
-            ],
-            'not_approved'      => [
-                'class' => 'ee-status-legend ee-status-bg--' . EEM_Registration::status_id_not_approved,
-                'desc'  => EEH_Template::pretty_status(
-                    EEM_Registration::status_id_not_approved,
-                    false,
-                    'sentence'
-                ),
-            ],
-            'declined_status'   => [
-                'class' => 'ee-status-legend ee-status-bg--' . EEM_Registration::status_id_declined,
-                'desc'  => EEH_Template::pretty_status(
-                    EEM_Registration::status_id_declined,
-                    false,
-                    'sentence'
-                ),
-            ],
-            'cancelled_status'  => [
-                'class' => 'ee-status-legend ee-status-bg--' . EEM_Registration::status_id_cancelled,
-                'desc'  => EEH_Template::pretty_status(
-                    EEM_Registration::status_id_cancelled,
-                    false,
-                    'sentence'
-                ),
-            ],
-        ];
-        return array_merge($fc_items, $sc_items);
-    }
-
-
-
-    /***************************************        REGISTRATION OVERVIEW        **************************************/
-
-
-    /**
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _registrations_overview_list_table()
-    {
-        $this->appendAddNewRegistrationButtonToPageTitle();
-        $header_text                  = '';
-        $admin_page_header_decorators = [
-            'EventEspresso\core\domain\services\admin\registrations\list_table\page_header\AttendeeFilterHeader',
-            'EventEspresso\core\domain\services\admin\registrations\list_table\page_header\EventFilterHeader',
-            'EventEspresso\core\domain\services\admin\registrations\list_table\page_header\DateFilterHeader',
-            'EventEspresso\core\domain\services\admin\registrations\list_table\page_header\TicketFilterHeader',
-        ];
-        foreach ($admin_page_header_decorators as $admin_page_header_decorator) {
-            $filter_header_decorator = $this->loader->getNew($admin_page_header_decorator);
-            $header_text = $filter_header_decorator->getHeaderText($header_text);
-        }
-        $this->_template_args['before_list_table']  = $header_text;
-        $this->_template_args['after_list_table']  = $this->_display_legend($this->_registration_legend_items());
-        $this->display_admin_list_table_page_with_no_sidebar();
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function appendAddNewRegistrationButtonToPageTitle()
-    {
-        $EVT_ID = $this->request->getRequestParam('event_id', 0, 'int');
-        if (
-            $EVT_ID
-            && EE_Registry::instance()->CAP->current_user_can(
-                'ee_edit_registrations',
-                'espresso_registrations_new_registration',
-                $EVT_ID
-            )
-        ) {
-            $this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
-                'new_registration',
-                'add-registrant',
-                ['event_id' => $EVT_ID],
-                'add-new-h2'
-            );
-        }
-    }
-
-
-    /**
-     * This sets the _registration property for the registration details screen
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _set_registration_object()
-    {
-        // get out if we've already set the object
-        if ($this->_registration instanceof EE_Registration) {
-            return;
-        }
-        $REG_ID = $this->request->getRequestParam('_REG_ID', 0, 'int');
-        if ($this->_registration = $this->getRegistrationModel()->get_one_by_ID($REG_ID)) {
-            return;
-        }
-        $error_msg = sprintf(
-            esc_html__(
-                'An error occurred and the details for Registration ID #%s could not be retrieved.',
-                'event_espresso'
-            ),
-            $REG_ID
-        );
-        EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
-        $this->_registration = null;
-    }
-
-
-    /**
-     * Used to retrieve registrations for the list table.
-     *
-     * @param int  $per_page
-     * @param bool $count
-     * @param bool $this_month
-     * @param bool $today
-     * @return EE_Registration[]|int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_registrations(
-        $per_page = 10,
-        $count = false,
-        $this_month = false,
-        $today = false
-    ) {
-        if ($this_month) {
-            $this->request->setRequestParam('status', 'month');
-        }
-        if ($today) {
-            $this->request->setRequestParam('status', 'today');
-        }
-        $query_params = $this->_get_registration_query_parameters($this->request->requestParams(), $per_page, $count);
-        /**
-         * Override the default groupby added by EEM_Base so that sorts with multiple order bys work as expected
-         *
-         * @link https://events.codebasehq.com/projects/event-espresso/tickets/10093
-         * @see  https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-         *                      or if you have the development copy of EE you can view this at the path:
-         *                      /docs/G--Model-System/model-query-params.md
-         */
-        $query_params['group_by'] = '';
-
-        return $count
-            ? $this->getRegistrationModel()->count($query_params)
-            /** @type EE_Registration[] */
-            : $this->getRegistrationModel()->get_all($query_params);
-    }
-
-
-    /**
-     * Retrieves the query parameters to be used by the Registration model for getting registrations.
-     * Note: this listens to values on the request for some of the query parameters.
-     *
-     * @param array $request
-     * @param int   $per_page
-     * @param bool  $count
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _get_registration_query_parameters(
-        $request = [],
-        $per_page = 10,
-        $count = false
-    ) {
-        /** @var EventEspresso\core\domain\services\admin\registrations\list_table\QueryBuilder $list_table_query_builder */
-        $list_table_query_builder = $this->loader->getNew(
-            'EventEspresso\core\domain\services\admin\registrations\list_table\QueryBuilder',
-            [null, null, $request]
-        );
-        return $list_table_query_builder->getQueryParams($per_page, $count);
-    }
-
-
-    public function get_registration_status_array()
-    {
-        return self::$_reg_status;
-    }
-
-
-
-
-    /***************************************        REGISTRATION DETAILS        ***************************************/
-    /**
-     * generates HTML for the View Registration Details Admin page
-     *
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws EntityNotFoundException
-     * @throws ReflectionException
-     */
-    protected function _registration_details()
-    {
-        $this->_template_args = [];
-        $this->_set_registration_object();
-        if (is_object($this->_registration)) {
-            $transaction                                   = $this->_registration->transaction()
-                ? $this->_registration->transaction()
-                : EE_Transaction::new_instance();
-            $this->_session                                = $transaction->session_data();
-            $event_id                                      = $this->_registration->event_ID();
-            $this->_template_args['reg_nmbr']['value']     = $this->_registration->ID();
-            $this->_template_args['reg_nmbr']['label']     = esc_html__('Registration Number', 'event_espresso');
-            $this->_template_args['reg_datetime']['value'] = $this->_registration->get_i18n_datetime('REG_date');
-            $this->_template_args['reg_datetime']['label'] = esc_html__('Date', 'event_espresso');
-            $this->_template_args['grand_total']           = $transaction->total();
-            $this->_template_args['currency_sign']         = EE_Registry::instance()->CFG->currency->sign;
-            // link back to overview
-            $this->_template_args['reg_overview_url']            = REG_ADMIN_URL;
-            $this->_template_args['registration']                = $this->_registration;
-            $this->_template_args['filtered_registrations_link'] = EE_Admin_Page::add_query_args_and_nonce(
-                [
-                    'action'   => 'default',
-                    'event_id' => $event_id,
-                ],
-                REG_ADMIN_URL
-            );
-            $this->_template_args['filtered_transactions_link']  = EE_Admin_Page::add_query_args_and_nonce(
-                [
-                    'action' => 'default',
-                    'EVT_ID' => $event_id,
-                    'page'   => 'espresso_transactions',
-                ],
-                admin_url('admin.php')
-            );
-            $this->_template_args['event_link']                  = EE_Admin_Page::add_query_args_and_nonce(
-                [
-                    'page'   => 'espresso_events',
-                    'action' => 'edit',
-                    'post'   => $event_id,
-                ],
-                admin_url('admin.php')
-            );
-            // next and previous links
-            $next_reg                                      = $this->_registration->next(
-                null,
-                [],
-                'REG_ID'
-            );
-            $this->_template_args['next_registration']     = $next_reg
-                ? $this->_next_link(
-                    EE_Admin_Page::add_query_args_and_nonce(
-                        [
-                            'action'  => 'view_registration',
-                            '_REG_ID' => $next_reg['REG_ID'],
-                        ],
-                        REG_ADMIN_URL
-                    ),
-                    'dashicons dashicons-arrow-right ee-icon-size-22'
-                )
-                : '';
-            $previous_reg                                  = $this->_registration->previous(
-                null,
-                [],
-                'REG_ID'
-            );
-            $this->_template_args['previous_registration'] = $previous_reg
-                ? $this->_previous_link(
-                    EE_Admin_Page::add_query_args_and_nonce(
-                        [
-                            'action'  => 'view_registration',
-                            '_REG_ID' => $previous_reg['REG_ID'],
-                        ],
-                        REG_ADMIN_URL
-                    ),
-                    'dashicons dashicons-arrow-left ee-icon-size-22'
-                )
-                : '';
-            // grab header
-            $template_path                             = REG_TEMPLATE_PATH . 'reg_admin_details_header.template.php';
-            $this->_template_args['REG_ID']            = $this->_registration->ID();
-            $this->_template_args['admin_page_header'] = EEH_Template::display_template(
-                $template_path,
-                $this->_template_args,
-                true
-            );
-        } else {
-            $this->_template_args['admin_page_header'] = '';
-            $this->_display_espresso_notices();
-        }
-        // the details template wrapper
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @since 4.10.2.p
-     */
-    protected function _registration_details_metaboxes()
-    {
-        do_action('AHEE__Registrations_Admin_Page___registration_details_metabox__start', $this);
-        $this->_set_registration_object();
-        $attendee = $this->_registration instanceof EE_Registration ? $this->_registration->attendee() : null;
-        $this->addMetaBox(
-            'edit-reg-status-mbox',
-            esc_html__('Registration Status', 'event_espresso'),
-            [$this, 'set_reg_status_buttons_metabox'],
-            $this->_wp_page_slug
-        );
-        $this->addMetaBox(
-            'edit-reg-details-mbox',
-            '<span>' . esc_html__('Registration Details', 'event_espresso')
-            . '&nbsp;<span class="dashicons dashicons-clipboard"></span></span>',
-            [$this, '_reg_details_meta_box'],
-            $this->_wp_page_slug
-        );
-        if (
-            $attendee instanceof EE_Attendee
-            && EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_registration',
-                'edit-reg-questions-mbox',
-                $this->_registration->ID()
-            )
-        ) {
-            $this->addMetaBox(
-                'edit-reg-questions-mbox',
-                esc_html__('Registration Form Answers', 'event_espresso'),
-                [$this, '_reg_questions_meta_box'],
-                $this->_wp_page_slug
-            );
-        }
-        $this->addMetaBox(
-            'edit-reg-registrant-mbox',
-            esc_html__('Contact Details', 'event_espresso'),
-            [$this, '_reg_registrant_side_meta_box'],
-            $this->_wp_page_slug,
-            'side'
-        );
-        if ($this->_registration->group_size() > 1) {
-            $this->addMetaBox(
-                'edit-reg-attendees-mbox',
-                esc_html__('Other Registrations in this Transaction', 'event_espresso'),
-                [$this, '_reg_attendees_meta_box'],
-                $this->_wp_page_slug
-            );
-        }
-    }
-
-
-    /**
-     * set_reg_status_buttons_metabox
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_reg_status_buttons_metabox()
-    {
-        $this->_set_registration_object();
-        $change_reg_status_form = $this->_generate_reg_status_change_form();
-        $output                 = $change_reg_status_form->form_open(
-            self::add_query_args_and_nonce(
-                [
-                    'action' => 'change_reg_status',
-                ],
-                REG_ADMIN_URL
-            )
-        );
-        $output                 .= $change_reg_status_form->get_html();
-        $output                 .= $change_reg_status_form->form_close();
-        echo wp_kses($output, AllowedTags::getWithFormTags());
-    }
-
-
-    /**
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws EntityNotFoundException
-     * @throws ReflectionException
-     */
-    protected function _generate_reg_status_change_form()
-    {
-        $reg_status_change_form_array = [
-            'name'            => 'reg_status_change_form',
-            'html_id'         => 'reg-status-change-form',
-            'layout_strategy' => new EE_Admin_Two_Column_Layout(),
-            'subsections'     => [
-                'return'         => new EE_Hidden_Input(
-                    [
-                        'name'    => 'return',
-                        'default' => 'view_registration',
-                    ]
-                ),
-                'REG_ID'         => new EE_Hidden_Input(
-                    [
-                        'name'    => 'REG_ID',
-                        'default' => $this->_registration->ID(),
-                    ]
-                ),
-            ],
-        ];
-        if (
-            EE_Registry::instance()->CAP->current_user_can(
-                'ee_edit_registration',
-                'toggle_registration_status',
-                $this->_registration->ID()
-            )
-        ) {
-            $reg_status_change_form_array['subsections']['reg_status']         = new EE_Select_Input(
-                $this->_get_reg_statuses(),
-                [
-                    'html_label_text' => esc_html__('Change Registration Status to', 'event_espresso'),
-                    'default'         => $this->_registration->status_ID(),
-                ]
-            );
-            $reg_status_change_form_array['subsections']['send_notifications'] = new EE_Yes_No_Input(
-                [
-                    'html_label_text' => esc_html__('Send Related Messages', 'event_espresso'),
-                    'default'         => false,
-                    'html_help_text'  => esc_html__(
-                        'If set to "Yes", then the related messages will be sent to the registrant.',
-                        'event_espresso'
-                    ),
-                ]
-            );
-            $reg_status_change_form_array['subsections']['submit']             = new EE_Submit_Input(
-                [
-                    'html_class'      => 'button--primary',
-                    'html_label_text' => '&nbsp;',
-                    'default'         => esc_html__('Update Registration Status', 'event_espresso'),
-                ]
-            );
-        }
-        return new EE_Form_Section_Proper($reg_status_change_form_array);
-    }
-
-
-    /**
-     * Returns an array of all the buttons for the various statuses and switch status actions
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws EntityNotFoundException
-     */
-    protected function _get_reg_statuses()
-    {
-        $reg_status_array = $this->getRegistrationModel()->reg_status_array();
-        unset($reg_status_array[ EEM_Registration::status_id_incomplete ]);
-        // get current reg status
-        $current_status = $this->_registration->status_ID();
-        // is registration for free event? This will determine whether to display the pending payment option
-        if (
-            $current_status !== EEM_Registration::status_id_pending_payment
-            && EEH_Money::compare_floats($this->_registration->ticket()->price(), 0.00)
-        ) {
-            unset($reg_status_array[ EEM_Registration::status_id_pending_payment ]);
-        }
-        return $this->getStatusModel()->localized_status($reg_status_array, false, 'sentence');
-    }
-
-
-    /**
-     * This method is used when using _REG_ID from request which may or may not be an array of reg_ids.
-     *
-     * @param bool $status REG status given for changing registrations to.
-     * @param bool $notify Whether to send messages notifications or not.
-     * @return array (array with reg_id(s) updated and whether update was successful.
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    protected function _set_registration_status_from_request($status = false, $notify = false)
-    {
-        $REG_IDs = $this->request->requestParamIsSet('reg_status_change_form')
-            ? $this->request->getRequestParam('reg_status_change_form[REG_ID]', [], 'int', true)
-            : $this->request->getRequestParam('_REG_ID', [], 'int', true);
-
-        // sanitize $REG_IDs
-        $REG_IDs = array_map('absint', $REG_IDs);
-        // and remove empty entries
-        $REG_IDs = array_filter($REG_IDs);
-
-        $result = $this->_set_registration_status($REG_IDs, $status, $notify);
-
-        /**
-         * Set and filter $_req_data['_REG_ID'] for any potential future messages notifications.
-         * Currently this value is used downstream by the _process_resend_registration method.
-         *
-         * @param int|array                $registration_ids The registration ids that have had their status changed successfully.
-         * @param bool                     $status           The status registrations were changed to.
-         * @param bool                     $success          If the status was changed successfully for all registrations.
-         * @param Registrations_Admin_Page $admin_page_object
-         */
-        $REG_ID = apply_filters(
-            'FHEE__Registrations_Admin_Page___set_registration_status_from_request__REG_IDs',
-            $result['REG_ID'],
-            $status,
-            $result['success'],
-            $this
-        );
-        $this->request->setRequestParam('_REG_ID', $REG_ID);
-
-        // notify?
-        if (
-            $notify
-            && $result['success']
-            && ! empty($REG_ID)
-            && EE_Registry::instance()->CAP->current_user_can(
-                'ee_send_message',
-                'espresso_registrations_resend_registration'
-            )
-        ) {
-            $this->_process_resend_registration();
-        }
-        return $result;
-    }
-
-
-    /**
-     * Set the registration status for the given reg_id (which may or may not be an array, it gets typecast to an
-     * array). Note, this method does NOT take care of possible notifications.  That is required by calling code.
-     *
-     * @param array  $REG_IDs
-     * @param string $status
-     * @param bool   $notify Used to indicate whether notification was requested or not.  This determines the context
-     *                       slug sent with setting the registration status.
-     * @return array (an array with 'success' key representing whether status change was successful, and 'REG_ID' as
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws EntityNotFoundException
-     * @throws DomainException
-     */
-    protected function _set_registration_status($REG_IDs = [], $status = '', $notify = false)
-    {
-        $success = false;
-        // typecast $REG_IDs
-        $REG_IDs = (array) $REG_IDs;
-        if (! empty($REG_IDs)) {
-            $success = true;
-            // set default status if none is passed
-            $status         = $status ?: EEM_Registration::status_id_pending_payment;
-            $status_context = $notify
-                ? Domain::CONTEXT_REGISTRATION_STATUS_CHANGE_REGISTRATION_ADMIN_NOTIFY
-                : Domain::CONTEXT_REGISTRATION_STATUS_CHANGE_REGISTRATION_ADMIN;
-            // loop through REG_ID's and change status
-            foreach ($REG_IDs as $REG_ID) {
-                $registration = $this->getRegistrationModel()->get_one_by_ID($REG_ID);
-                if ($registration instanceof EE_Registration) {
-                    $registration->set_status(
-                        $status,
-                        false,
-                        new Context(
-                            $status_context,
-                            esc_html__(
-                                'Manually triggered status change on a Registration Admin Page route.',
-                                'event_espresso'
-                            )
-                        )
-                    );
-                    $result = $registration->save();
-                    // verifying explicit fails because update *may* just return 0 for 0 rows affected
-                    $success = $result !== false ? $success : false;
-                }
-            }
-        }
-
-        // return $success and processed registrations
-        return ['REG_ID' => $REG_IDs, 'success' => $success];
-    }
-
-
-    /**
-     * Common logic for setting up success message and redirecting to appropriate route
-     *
-     * @param string $STS_ID status id for the registration changed to
-     * @param bool   $notify indicates whether the _set_registration_status_from_request does notifications or not.
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    protected function _reg_status_change_return($STS_ID, $notify = false)
-    {
-        $result  = ! empty($STS_ID) ? $this->_set_registration_status_from_request($STS_ID, $notify)
-            : ['success' => false];
-        $success = isset($result['success']) && $result['success'];
-        // setup success message
-        if ($success) {
-            if (is_array($result['REG_ID']) && count($result['REG_ID']) === 1) {
-                $msg = sprintf(
-                    esc_html__('Registration status has been set to %s', 'event_espresso'),
-                    EEH_Template::pretty_status($STS_ID, false, 'lower')
-                );
-            } else {
-                $msg = sprintf(
-                    esc_html__('Registrations have been set to %s.', 'event_espresso'),
-                    EEH_Template::pretty_status($STS_ID, false, 'lower')
-                );
-            }
-            EE_Error::add_success($msg);
-        } else {
-            EE_Error::add_error(
-                esc_html__(
-                    'Something went wrong, and the status was not changed',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __LINE__,
-                __FUNCTION__
-            );
-        }
-        $return = $this->request->getRequestParam('return');
-        $route  = $return === 'view_registration'
-            ? ['action' => 'view_registration', '_REG_ID' => reset($result['REG_ID'])]
-            : ['action' => 'default'];
-        $route  = $this->mergeExistingRequestParamsWithRedirectArgs($route);
-        $this->_redirect_after_action($success, '', '', $route, true);
-    }
-
-
-    /**
-     * incoming reg status change from reg details page.
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws DomainException
-     */
-    protected function _change_reg_status()
-    {
-        $this->request->setRequestParam('return', 'view_registration');
-        // set notify based on whether the send notifications toggle is set or not
-        $notify     = $this->request->getRequestParam('reg_status_change_form[send_notifications]', false, 'bool');
-        $reg_status = $this->request->getRequestParam('reg_status_change_form[reg_status]', '');
-        $this->request->setRequestParam('reg_status_change_form[reg_status]', $reg_status);
-        switch ($reg_status) {
-            case EEM_Registration::status_id_approved:
-            case EEH_Template::pretty_status(EEM_Registration::status_id_approved, false, 'sentence'):
-                $this->approve_registration($notify);
-                break;
-            case EEM_Registration::status_id_pending_payment:
-            case EEH_Template::pretty_status(EEM_Registration::status_id_pending_payment, false, 'sentence'):
-                $this->pending_registration($notify);
-                break;
-            case EEM_Registration::status_id_not_approved:
-            case EEH_Template::pretty_status(EEM_Registration::status_id_not_approved, false, 'sentence'):
-                $this->not_approve_registration($notify);
-                break;
-            case EEM_Registration::status_id_declined:
-            case EEH_Template::pretty_status(EEM_Registration::status_id_declined, false, 'sentence'):
-                $this->decline_registration($notify);
-                break;
-            case EEM_Registration::status_id_cancelled:
-            case EEH_Template::pretty_status(EEM_Registration::status_id_cancelled, false, 'sentence'):
-                $this->cancel_registration($notify);
-                break;
-            case EEM_Registration::status_id_wait_list:
-            case EEH_Template::pretty_status(EEM_Registration::status_id_wait_list, false, 'sentence'):
-                $this->wait_list_registration($notify);
-                break;
-            case EEM_Registration::status_id_incomplete:
-            default:
-                $this->request->unSetRequestParam('return');
-                $this->_reg_status_change_return('');
-                break;
-        }
-    }
-
-
-    /**
-     * Callback for bulk action routes.
-     * Note: although we could just register the singular route callbacks for each bulk action route as well, this
-     * method was chosen so there is one central place all the registration status bulk actions are going through.
-     * Potentially, this provides an easier place to locate logic that is specific to these bulk actions (as opposed to
-     * when an action is happening on just a single registration).
-     *
-     * @param      $action
-     * @param bool $notify
-     */
-    protected function bulk_action_on_registrations($action, $notify = false)
-    {
-        do_action(
-            'AHEE__Registrations_Admin_Page__bulk_action_on_registrations__before_execution',
-            $this,
-            $action,
-            $notify
-        );
-        $method = $action . '_registration';
-        if (method_exists($this, $method)) {
-            $this->$method($notify);
-        }
-    }
-
-
-    /**
-     * approve_registration
-     *
-     * @param bool $notify whether or not to notify the registrant about their approval.
-     * @return void
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws DomainException
-     */
-    protected function approve_registration($notify = false)
-    {
-        $this->_reg_status_change_return(EEM_Registration::status_id_approved, $notify);
-    }
-
-
-    /**
-     * decline_registration
-     *
-     * @param bool $notify whether or not to notify the registrant about their status change.
-     * @return void
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws DomainException
-     */
-    protected function decline_registration($notify = false)
-    {
-        $this->_reg_status_change_return(EEM_Registration::status_id_declined, $notify);
-    }
-
-
-    /**
-     * cancel_registration
-     *
-     * @param bool $notify whether or not to notify the registrant about their status change.
-     * @return void
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws DomainException
-     */
-    protected function cancel_registration($notify = false)
-    {
-        $this->_reg_status_change_return(EEM_Registration::status_id_cancelled, $notify);
-    }
-
-
-    /**
-     * not_approve_registration
-     *
-     * @param bool $notify whether or not to notify the registrant about their status change.
-     * @return void
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws DomainException
-     */
-    protected function not_approve_registration($notify = false)
-    {
-        $this->_reg_status_change_return(EEM_Registration::status_id_not_approved, $notify);
-    }
-
-
-    /**
-     * decline_registration
-     *
-     * @param bool $notify whether or not to notify the registrant about their status change.
-     * @return void
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws DomainException
-     */
-    protected function pending_registration($notify = false)
-    {
-        $this->_reg_status_change_return(EEM_Registration::status_id_pending_payment, $notify);
-    }
-
-
-    /**
-     * waitlist_registration
-     *
-     * @param bool $notify whether or not to notify the registrant about their status change.
-     * @return void
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws DomainException
-     */
-    protected function wait_list_registration($notify = false)
-    {
-        $this->_reg_status_change_return(EEM_Registration::status_id_wait_list, $notify);
-    }
-
-
-    /**
-     * generates HTML for the Registration main meta box
-     *
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws EntityNotFoundException
-     */
-    public function _reg_details_meta_box()
-    {
-        EEH_Autoloader::register_line_item_display_autoloaders();
-        EEH_Autoloader::register_line_item_filter_autoloaders();
-        EE_Registry::instance()->load_helper('Line_Item');
-        $transaction    = $this->_registration->transaction() ? $this->_registration->transaction()
-            : EE_Transaction::new_instance();
-        $this->_session = $transaction->session_data();
-        $filters        = new EE_Line_Item_Filter_Collection();
-        $filters->add(new EE_Single_Registration_Line_Item_Filter($this->_registration));
-        $filters->add(new EE_Non_Zero_Line_Item_Filter());
-        $line_item_filter_processor              = new EE_Line_Item_Filter_Processor(
-            $filters,
-            $transaction->total_line_item()
-        );
-        $filtered_line_item_tree                 = $line_item_filter_processor->process();
-        $line_item_display                       = new EE_Line_Item_Display(
-            'reg_admin_table',
-            'EE_Admin_Table_Registration_Line_Item_Display_Strategy'
-        );
-        $this->_template_args['line_item_table'] = $line_item_display->display_line_item(
-            $filtered_line_item_tree,
-            ['EE_Registration' => $this->_registration]
-        );
-        $attendee                                = $this->_registration->attendee();
-        if (
-            EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_transaction',
-                'espresso_transactions_view_transaction'
-            )
-        ) {
-            $this->_template_args['view_transaction_button'] = EEH_Template::get_button_or_link(
-                EE_Admin_Page::add_query_args_and_nonce(
-                    [
-                        'action' => 'view_transaction',
-                        'TXN_ID' => $transaction->ID(),
-                    ],
-                    TXN_ADMIN_URL
-                ),
-                esc_html__(' View Transaction', 'event_espresso'),
-                'button button--secondary right',
-                'dashicons dashicons-cart'
-            );
-        } else {
-            $this->_template_args['view_transaction_button'] = '';
-        }
-        if (
-            $attendee instanceof EE_Attendee
-            && EE_Registry::instance()->CAP->current_user_can(
-                'ee_send_message',
-                'espresso_registrations_resend_registration'
-            )
-        ) {
-            $this->_template_args['resend_registration_button'] = EEH_Template::get_button_or_link(
-                EE_Admin_Page::add_query_args_and_nonce(
-                    [
-                        'action'      => 'resend_registration',
-                        '_REG_ID'     => $this->_registration->ID(),
-                        'redirect_to' => 'view_registration',
-                    ],
-                    REG_ADMIN_URL
-                ),
-                esc_html__(' Resend Registration', 'event_espresso'),
-                'button button--secondary right',
-                'dashicons dashicons-email-alt'
-            );
-        } else {
-            $this->_template_args['resend_registration_button'] = '';
-        }
-        $this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign;
-        $payment                               = $transaction->get_first_related('Payment');
-        $payment                               = ! $payment instanceof EE_Payment
-            ? EE_Payment::new_instance()
-            : $payment;
-        $payment_method                        = $payment->get_first_related('Payment_Method');
-        $payment_method                        = ! $payment_method instanceof EE_Payment_Method
-            ? EE_Payment_Method::new_instance()
-            : $payment_method;
-        $reg_details                           = [
-            'payment_method'       => $payment_method->name(),
-            'response_msg'         => $payment->gateway_response(),
-            'registration_id'      => $this->_registration->get('REG_code'),
-            'registration_session' => $this->_registration->session_ID(),
-            'ip_address'           => isset($this->_session['ip_address']) ? $this->_session['ip_address'] : '',
-            'user_agent'           => isset($this->_session['user_agent']) ? $this->_session['user_agent'] : '',
-        ];
-        if (isset($reg_details['registration_id'])) {
-            $this->_template_args['reg_details']['registration_id']['value'] = $reg_details['registration_id'];
-            $this->_template_args['reg_details']['registration_id']['label'] = esc_html__(
-                'Registration ID',
-                'event_espresso'
-            );
-            $this->_template_args['reg_details']['registration_id']['class'] = 'regular-text';
-        }
-        if (isset($reg_details['payment_method'])) {
-            $this->_template_args['reg_details']['payment_method']['value'] = $reg_details['payment_method'];
-            $this->_template_args['reg_details']['payment_method']['label'] = esc_html__(
-                'Most Recent Payment Method',
-                'event_espresso'
-            );
-            $this->_template_args['reg_details']['payment_method']['class'] = 'regular-text';
-            $this->_template_args['reg_details']['response_msg']['value']   = $reg_details['response_msg'];
-            $this->_template_args['reg_details']['response_msg']['label']   = esc_html__(
-                'Payment method response',
-                'event_espresso'
-            );
-            $this->_template_args['reg_details']['response_msg']['class']   = 'regular-text';
-        }
-        $this->_template_args['reg_details']['registration_session']['value'] = $reg_details['registration_session'];
-        $this->_template_args['reg_details']['registration_session']['label'] = esc_html__(
-            'Registration Session',
-            'event_espresso'
-        );
-        $this->_template_args['reg_details']['registration_session']['class'] = 'regular-text';
-        $this->_template_args['reg_details']['ip_address']['value']           = $reg_details['ip_address'];
-        $this->_template_args['reg_details']['ip_address']['label']           = esc_html__(
-            'Registration placed from IP',
-            'event_espresso'
-        );
-        $this->_template_args['reg_details']['ip_address']['class']           = 'regular-text';
-        $this->_template_args['reg_details']['user_agent']['value']           = $reg_details['user_agent'];
-        $this->_template_args['reg_details']['user_agent']['label']           = esc_html__(
-            'Registrant User Agent',
-            'event_espresso'
-        );
-        $this->_template_args['reg_details']['user_agent']['class']           = 'large-text';
-        $this->_template_args['event_link']                                   = EE_Admin_Page::add_query_args_and_nonce(
-            [
-                'action'   => 'default',
-                'event_id' => $this->_registration->event_ID(),
-            ],
-            REG_ADMIN_URL
-        );
-
-        $this->_template_args['REG_ID'] = $this->_registration->ID();
-        $this->_template_args['event_id'] = $this->_registration->event_ID();
-
-        $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_details.template.php';
-        EEH_Template::display_template($template_path, $this->_template_args); // already escaped
-    }
-
-
-    /**
-     * generates HTML for the Registration Questions meta box.
-     * If pre-4.8.32.rc.000 hooks are used, uses old methods (with its filters),
-     * otherwise uses new forms system
-     *
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function _reg_questions_meta_box()
-    {
-        // allow someone to override this method entirely
-        if (
-            apply_filters(
-                'FHEE__Registrations_Admin_Page___reg_questions_meta_box__do_default',
-                true,
-                $this,
-                $this->_registration
-            )
-        ) {
-            $form = $this->_get_reg_custom_questions_form(
-                $this->_registration->ID()
-            );
-
-            $this->_template_args['att_questions'] = count($form->subforms()) > 0
-                ? $form->get_html_and_js()
-                : '';
-
-            $this->_template_args['reg_questions_form_action'] = 'edit_registration';
-            $this->_template_args['REG_ID'] = $this->_registration->ID();
-            $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_questions.template.php';
-            EEH_Template::display_template($template_path, $this->_template_args);
-        }
-    }
-
-
-    /**
-     * form_before_question_group
-     *
-     * @param string $output
-     * @return        string
-     * @deprecated    as of 4.8.32.rc.000
-     */
-    public function form_before_question_group($output)
-    {
-        EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
-            esc_html__(
-                'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.',
-                'event_espresso'
-            ),
-            '4.8.32.rc.000'
-        );
-        return '
+	/**
+	 * @var EE_Registration
+	 */
+	private $_registration;
+
+	/**
+	 * @var EE_Event
+	 */
+	private $_reg_event;
+
+	/**
+	 * @var EE_Session
+	 */
+	private $_session;
+
+	/**
+	 * @var array
+	 */
+	private static $_reg_status;
+
+	/**
+	 * Form for displaying the custom questions for this registration.
+	 * This gets used a few times throughout the request so its best to cache it
+	 *
+	 * @var EE_Registration_Custom_Questions_Form
+	 */
+	protected $_reg_custom_questions_form;
+
+	/**
+	 * @var EEM_Registration $registration_model
+	 */
+	private $registration_model;
+
+	/**
+	 * @var EEM_Attendee $attendee_model
+	 */
+	private $attendee_model;
+
+	/**
+	 * @var EEM_Event $event_model
+	 */
+	private $event_model;
+
+	/**
+	 * @var EEM_Status $status_model
+	 */
+	private $status_model;
+
+
+	/**
+	 * @param bool $routing
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function __construct($routing = true)
+	{
+		parent::__construct($routing);
+		add_action('wp_loaded', [$this, 'wp_loaded']);
+	}
+
+
+	/**
+	 * @return EEM_Registration
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @since 4.10.2.p
+	 */
+	protected function getRegistrationModel()
+	{
+		if (! $this->registration_model instanceof EEM_Registration) {
+			$this->registration_model = $this->loader->getShared('EEM_Registration');
+		}
+		return $this->registration_model;
+	}
+
+
+	/**
+	 * @return EEM_Attendee
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @since 4.10.2.p
+	 */
+	protected function getAttendeeModel()
+	{
+		if (! $this->attendee_model instanceof EEM_Attendee) {
+			$this->attendee_model = $this->loader->getShared('EEM_Attendee');
+		}
+		return $this->attendee_model;
+	}
+
+
+	/**
+	 * @return EEM_Event
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @since 4.10.2.p
+	 */
+	protected function getEventModel()
+	{
+		if (! $this->event_model instanceof EEM_Event) {
+			$this->event_model = $this->loader->getShared('EEM_Event');
+		}
+		return $this->event_model;
+	}
+
+
+	/**
+	 * @return EEM_Status
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @since 4.10.2.p
+	 */
+	protected function getStatusModel()
+	{
+		if (! $this->status_model instanceof EEM_Status) {
+			$this->status_model = $this->loader->getShared('EEM_Status');
+		}
+		return $this->status_model;
+	}
+
+
+	public function wp_loaded()
+	{
+		// when adding a new registration...
+		$action = $this->request->getRequestParam('action');
+		if ($action === 'new_registration') {
+			EE_System::do_not_cache();
+			if ($this->request->getRequestParam('processing_registration', 0, 'int') !== 1) {
+				// and it's NOT the attendee information reg step
+				// force cookie expiration by setting time to last week
+				setcookie('ee_registration_added', 0, time() - WEEK_IN_SECONDS, '/');
+				// and update the global
+				$_COOKIE['ee_registration_added'] = 0;
+			}
+		}
+	}
+
+
+	protected function _init_page_props()
+	{
+		$this->page_slug        = REG_PG_SLUG;
+		$this->_admin_base_url  = REG_ADMIN_URL;
+		$this->_admin_base_path = REG_ADMIN;
+		$this->page_label       = esc_html__('Registrations', 'event_espresso');
+		$this->_cpt_routes      = [
+			'add_new_attendee' => 'espresso_attendees',
+			'edit_attendee'    => 'espresso_attendees',
+			'insert_attendee'  => 'espresso_attendees',
+			'update_attendee'  => 'espresso_attendees',
+		];
+		$this->_cpt_model_names = [
+			'add_new_attendee' => 'EEM_Attendee',
+			'edit_attendee'    => 'EEM_Attendee',
+		];
+		$this->_cpt_edit_routes = [
+			'espresso_attendees' => 'edit_attendee',
+		];
+		$this->_pagenow_map     = [
+			'add_new_attendee' => 'post-new.php',
+			'edit_attendee'    => 'post.php',
+			'trash'            => 'post.php',
+		];
+		add_action('edit_form_after_title', [$this, 'after_title_form_fields'], 10);
+		// add filters so that the comment urls don't take users to a confusing 404 page
+		add_filter('get_comment_link', [$this, 'clear_comment_link'], 10, 2);
+	}
+
+
+	/**
+	 * @param string     $link    The comment permalink with '#comment-$id' appended.
+	 * @param WP_Comment $comment The current comment object.
+	 * @return string
+	 */
+	public function clear_comment_link($link, WP_Comment $comment)
+	{
+		// gotta make sure this only happens on this route
+		$post_type = get_post_type($comment->comment_post_ID);
+		if ($post_type === 'espresso_attendees') {
+			return '#commentsdiv';
+		}
+		return $link;
+	}
+
+
+	protected function _ajax_hooks()
+	{
+		// todo: all hooks for registrations ajax goes in here
+		add_action('wp_ajax_toggle_checkin_status', [$this, 'toggle_checkin_status']);
+	}
+
+
+	protected function _define_page_props()
+	{
+		$this->_admin_page_title = $this->page_label;
+		$this->_labels           = [
+			'buttons'                      => [
+				'add-registrant'      => esc_html__('Add New Registration', 'event_espresso'),
+				'add-attendee'        => esc_html__('Add Contact', 'event_espresso'),
+				'edit'                => esc_html__('Edit Contact', 'event_espresso'),
+				'report'              => esc_html__('Event Registrations CSV Report', 'event_espresso'),
+				'report_datetime'     => esc_html__('Datetime Registrations CSV Report', 'event_espresso'),
+				'report_all'          => esc_html__('All Registrations CSV Report', 'event_espresso'),
+				'report_filtered'     => esc_html__('Filtered CSV Report', 'event_espresso'),
+				'contact_list_report' => esc_html__('Contact List Report', 'event_espresso'),
+				'contact_list_export' => esc_html__('Export Data', 'event_espresso'),
+			],
+			'publishbox'                   => [
+				'add_new_attendee' => esc_html__('Add Contact Record', 'event_espresso'),
+				'edit_attendee'    => esc_html__('Update Contact Record', 'event_espresso'),
+			],
+			'hide_add_button_on_cpt_route' => [
+				'edit_attendee' => true,
+			],
+		];
+	}
+
+
+	/**
+	 * grab url requests and route them
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function _set_page_routes()
+	{
+		$this->_get_registration_status_array();
+		$REG_ID             = $this->request->getRequestParam('_REG_ID', 0, 'int');
+		$REG_ID             = $this->request->getRequestParam('reg_status_change_form[REG_ID]', $REG_ID, 'int');
+		$ATT_ID             = $this->request->getRequestParam('ATT_ID', 0, 'int');
+		$ATT_ID             = $this->request->getRequestParam('post', $ATT_ID, 'int');
+		$this->_page_routes = [
+			'default'                             => [
+				'func'       => '_registrations_overview_list_table',
+				'capability' => 'ee_read_registrations',
+			],
+			'view_registration'                   => [
+				'func'       => '_registration_details',
+				'capability' => 'ee_read_registration',
+				'obj_id'     => $REG_ID,
+			],
+			'edit_registration'                   => [
+				'func'               => '_update_attendee_registration_form',
+				'noheader'           => true,
+				'headers_sent_route' => 'view_registration',
+				'capability'         => 'ee_edit_registration',
+				'obj_id'             => $REG_ID,
+				'_REG_ID'            => $REG_ID,
+			],
+			'trash_registrations'                 => [
+				'func'       => '_trash_or_restore_registrations',
+				'args'       => ['trash' => true],
+				'noheader'   => true,
+				'capability' => 'ee_delete_registrations',
+			],
+			'restore_registrations'               => [
+				'func'       => '_trash_or_restore_registrations',
+				'args'       => ['trash' => false],
+				'noheader'   => true,
+				'capability' => 'ee_delete_registrations',
+			],
+			'delete_registrations'                => [
+				'func'       => '_delete_registrations',
+				'noheader'   => true,
+				'capability' => 'ee_delete_registrations',
+			],
+			'new_registration'                    => [
+				'func'       => 'new_registration',
+				'capability' => 'ee_edit_registrations',
+			],
+			'process_reg_step'                    => [
+				'func'       => 'process_reg_step',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registrations',
+			],
+			'redirect_to_txn'                     => [
+				'func'       => 'redirect_to_txn',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registrations',
+			],
+			'change_reg_status'                   => [
+				'func'       => '_change_reg_status',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $REG_ID,
+			],
+			'approve_registration'                => [
+				'func'       => 'approve_registration',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $REG_ID,
+			],
+			'approve_and_notify_registration'     => [
+				'func'       => 'approve_registration',
+				'noheader'   => true,
+				'args'       => [true],
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $REG_ID,
+			],
+			'approve_registrations'               => [
+				'func'       => 'bulk_action_on_registrations',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registrations',
+				'args'       => ['approve'],
+			],
+			'approve_and_notify_registrations'    => [
+				'func'       => 'bulk_action_on_registrations',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registrations',
+				'args'       => ['approve', true],
+			],
+			'decline_registration'                => [
+				'func'       => 'decline_registration',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $REG_ID,
+			],
+			'decline_and_notify_registration'     => [
+				'func'       => 'decline_registration',
+				'noheader'   => true,
+				'args'       => [true],
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $REG_ID,
+			],
+			'decline_registrations'               => [
+				'func'       => 'bulk_action_on_registrations',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registrations',
+				'args'       => ['decline'],
+			],
+			'decline_and_notify_registrations'    => [
+				'func'       => 'bulk_action_on_registrations',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registrations',
+				'args'       => ['decline', true],
+			],
+			'pending_registration'                => [
+				'func'       => 'pending_registration',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $REG_ID,
+			],
+			'pending_and_notify_registration'     => [
+				'func'       => 'pending_registration',
+				'noheader'   => true,
+				'args'       => [true],
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $REG_ID,
+			],
+			'pending_registrations'               => [
+				'func'       => 'bulk_action_on_registrations',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registrations',
+				'args'       => ['pending'],
+			],
+			'pending_and_notify_registrations'    => [
+				'func'       => 'bulk_action_on_registrations',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registrations',
+				'args'       => ['pending', true],
+			],
+			'no_approve_registration'             => [
+				'func'       => 'not_approve_registration',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $REG_ID,
+			],
+			'no_approve_and_notify_registration'  => [
+				'func'       => 'not_approve_registration',
+				'noheader'   => true,
+				'args'       => [true],
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $REG_ID,
+			],
+			'no_approve_registrations'            => [
+				'func'       => 'bulk_action_on_registrations',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registrations',
+				'args'       => ['not_approve'],
+			],
+			'no_approve_and_notify_registrations' => [
+				'func'       => 'bulk_action_on_registrations',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registrations',
+				'args'       => ['not_approve', true],
+			],
+			'cancel_registration'                 => [
+				'func'       => 'cancel_registration',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $REG_ID,
+			],
+			'cancel_and_notify_registration'      => [
+				'func'       => 'cancel_registration',
+				'noheader'   => true,
+				'args'       => [true],
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $REG_ID,
+			],
+			'cancel_registrations'                => [
+				'func'       => 'bulk_action_on_registrations',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registrations',
+				'args'       => ['cancel'],
+			],
+			'cancel_and_notify_registrations'     => [
+				'func'       => 'bulk_action_on_registrations',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registrations',
+				'args'       => ['cancel', true],
+			],
+			'wait_list_registration'              => [
+				'func'       => 'wait_list_registration',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $REG_ID,
+			],
+			'wait_list_and_notify_registration'   => [
+				'func'       => 'wait_list_registration',
+				'noheader'   => true,
+				'args'       => [true],
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $REG_ID,
+			],
+			'contact_list'                        => [
+				'func'       => '_attendee_contact_list_table',
+				'capability' => 'ee_read_contacts',
+			],
+			'add_new_attendee'                    => [
+				'func' => '_create_new_cpt_item',
+				'args' => [
+					'new_attendee' => true,
+					'capability'   => 'ee_edit_contacts',
+				],
+			],
+			'edit_attendee'                       => [
+				'func'       => '_edit_cpt_item',
+				'capability' => 'ee_edit_contacts',
+				'obj_id'     => $ATT_ID,
+			],
+			'duplicate_attendee'                  => [
+				'func'       => '_duplicate_attendee',
+				'noheader'   => true,
+				'capability' => 'ee_edit_contacts',
+				'obj_id'     => $ATT_ID,
+			],
+			'insert_attendee'                     => [
+				'func'       => '_insert_or_update_attendee',
+				'args'       => [
+					'new_attendee' => true,
+				],
+				'noheader'   => true,
+				'capability' => 'ee_edit_contacts',
+			],
+			'update_attendee'                     => [
+				'func'       => '_insert_or_update_attendee',
+				'args'       => [
+					'new_attendee' => false,
+				],
+				'noheader'   => true,
+				'capability' => 'ee_edit_contacts',
+				'obj_id'     => $ATT_ID,
+			],
+			'trash_attendees'                     => [
+				'func'       => '_trash_or_restore_attendees',
+				'args'       => [
+					'trash' => 'true',
+				],
+				'noheader'   => true,
+				'capability' => 'ee_delete_contacts',
+			],
+			'trash_attendee'                      => [
+				'func'       => '_trash_or_restore_attendees',
+				'args'       => [
+					'trash' => true,
+				],
+				'noheader'   => true,
+				'capability' => 'ee_delete_contacts',
+				'obj_id'     => $ATT_ID,
+			],
+			'restore_attendees'                   => [
+				'func'       => '_trash_or_restore_attendees',
+				'args'       => [
+					'trash' => false,
+				],
+				'noheader'   => true,
+				'capability' => 'ee_delete_contacts',
+				'obj_id'     => $ATT_ID,
+			],
+			'resend_registration'                 => [
+				'func'       => '_resend_registration',
+				'noheader'   => true,
+				'capability' => 'ee_send_message',
+			],
+			'registrations_report'                => [
+				'func'       => '_registrations_report',
+				'noheader'   => true,
+				'capability' => 'ee_read_registrations',
+			],
+			'contact_list_export'                 => [
+				'func'       => '_contact_list_export',
+				'noheader'   => true,
+				'capability' => 'export',
+			],
+			'contact_list_report'                 => [
+				'func'       => '_contact_list_report',
+				'noheader'   => true,
+				'capability' => 'ee_read_contacts',
+			],
+		];
+	}
+
+
+	protected function _set_page_config()
+	{
+		$REG_ID             = $this->request->getRequestParam('_REG_ID', 0, 'int');
+		$ATT_ID             = $this->request->getRequestParam('ATT_ID', 0, 'int');
+		$this->_page_config = [
+			'default'           => [
+				'nav'           => [
+					'label' => esc_html__('Overview', 'event_espresso'),
+					'icon' => 'dashicons-list-view',
+					'order' => 5,
+				],
+				'help_tabs'     => [
+					'registrations_overview_help_tab'                       => [
+						'title'    => esc_html__('Registrations Overview', 'event_espresso'),
+						'filename' => 'registrations_overview',
+					],
+					'registrations_overview_table_column_headings_help_tab' => [
+						'title'    => esc_html__('Registrations Table Column Headings', 'event_espresso'),
+						'filename' => 'registrations_overview_table_column_headings',
+					],
+					'registrations_overview_filters_help_tab'               => [
+						'title'    => esc_html__('Registration Filters', 'event_espresso'),
+						'filename' => 'registrations_overview_filters',
+					],
+					'registrations_overview_views_help_tab'                 => [
+						'title'    => esc_html__('Registration Views', 'event_espresso'),
+						'filename' => 'registrations_overview_views',
+					],
+					'registrations_regoverview_other_help_tab'              => [
+						'title'    => esc_html__('Registrations Other', 'event_espresso'),
+						'filename' => 'registrations_overview_other',
+					],
+				],
+				'list_table'    => 'EE_Registrations_List_Table',
+				'require_nonce' => false,
+			],
+			'view_registration' => [
+				'nav'           => [
+					'label'      => esc_html__('REG Details', 'event_espresso'),
+					'icon' => 'dashicons-clipboard',
+					'order'      => 15,
+					'url'        => $REG_ID
+						? add_query_arg(['_REG_ID' => $REG_ID], $this->_current_page_view_url)
+						: $this->_admin_base_url,
+					'persistent' => false,
+				],
+				'help_tabs'     => [
+					'registrations_details_help_tab'                    => [
+						'title'    => esc_html__('Registration Details', 'event_espresso'),
+						'filename' => 'registrations_details',
+					],
+					'registrations_details_table_help_tab'              => [
+						'title'    => esc_html__('Registration Details Table', 'event_espresso'),
+						'filename' => 'registrations_details_table',
+					],
+					'registrations_details_form_answers_help_tab'       => [
+						'title'    => esc_html__('Registration Form Answers', 'event_espresso'),
+						'filename' => 'registrations_details_form_answers',
+					],
+					'registrations_details_registrant_details_help_tab' => [
+						'title'    => esc_html__('Contact Details', 'event_espresso'),
+						'filename' => 'registrations_details_registrant_details',
+					],
+				],
+				'metaboxes'     => array_merge(
+					$this->_default_espresso_metaboxes,
+					['_registration_details_metaboxes']
+				),
+				'require_nonce' => false,
+			],
+			'new_registration'  => [
+				'nav'           => [
+					'label'      => esc_html__('Add New Registration', 'event_espresso'),
+					'icon' => 'dashicons-plus-alt',
+					'url'        => '#',
+					'order'      => 15,
+					'persistent' => false,
+				],
+				'metaboxes'     => $this->_default_espresso_metaboxes,
+				'labels'        => [
+					'publishbox' => esc_html__('Save Registration', 'event_espresso'),
+				],
+				'require_nonce' => false,
+			],
+			'add_new_attendee'  => [
+				'nav'           => [
+					'label'      => esc_html__('Add Contact', 'event_espresso'),
+					'icon' => 'dashicons-plus-alt',
+					'order'      => 15,
+					'persistent' => false,
+				],
+				'metaboxes'     => array_merge(
+					$this->_default_espresso_metaboxes,
+					['_publish_post_box', 'attendee_editor_metaboxes']
+				),
+				'require_nonce' => false,
+			],
+			'edit_attendee'     => [
+				'nav'           => [
+					'label'      => esc_html__('Edit Contact', 'event_espresso'),
+					'icon' => 'dashicons-edit-large',
+					'order'      => 15,
+					'persistent' => false,
+					'url'        => $ATT_ID
+						? add_query_arg(['ATT_ID' => $ATT_ID], $this->_current_page_view_url)
+						: $this->_admin_base_url,
+				],
+				'metaboxes'     => array_merge(
+					$this->_default_espresso_metaboxes,
+					['attendee_editor_metaboxes']
+				),
+				'require_nonce' => false,
+			],
+			'contact_list'      => [
+				'nav'           => [
+					'label' => esc_html__('Contact List', 'event_espresso'),
+					'icon' => 'dashicons-id-alt',
+					'order' => 20,
+				],
+				'list_table'    => 'EE_Attendee_Contact_List_Table',
+				'help_tabs'     => [
+					'registrations_contact_list_help_tab'                       => [
+						'title'    => esc_html__('Registrations Contact List', 'event_espresso'),
+						'filename' => 'registrations_contact_list',
+					],
+					'registrations_contact-list_table_column_headings_help_tab' => [
+						'title'    => esc_html__('Contact List Table Column Headings', 'event_espresso'),
+						'filename' => 'registrations_contact_list_table_column_headings',
+					],
+					'registrations_contact_list_views_help_tab'                 => [
+						'title'    => esc_html__('Contact List Views', 'event_espresso'),
+						'filename' => 'registrations_contact_list_views',
+					],
+					'registrations_contact_list_other_help_tab'                 => [
+						'title'    => esc_html__('Contact List Other', 'event_espresso'),
+						'filename' => 'registrations_contact_list_other',
+					],
+				],
+				'metaboxes'     => [],
+				'require_nonce' => false,
+			],
+			// override default cpt routes
+			'create_new'        => '',
+			'edit'              => '',
+		];
+	}
+
+
+	/**
+	 * The below methods aren't used by this class currently
+	 */
+	protected function _add_screen_options()
+	{
+	}
+
+
+	protected function _add_feature_pointers()
+	{
+	}
+
+
+	public function admin_init()
+	{
+		EE_Registry::$i18n_js_strings['update_att_qstns'] = esc_html__(
+			'click "Update Registration Questions" to save your changes',
+			'event_espresso'
+		);
+	}
+
+
+	public function admin_notices()
+	{
+	}
+
+
+	public function admin_footer_scripts()
+	{
+	}
+
+
+	/**
+	 * get list of registration statuses
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private function _get_registration_status_array()
+	{
+		self::$_reg_status = EEM_Registration::reg_status_array([], true);
+	}
+
+
+	/**
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @since 4.10.2.p
+	 */
+	protected function _add_screen_options_default()
+	{
+		$this->_per_page_screen_option();
+	}
+
+
+	/**
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @since 4.10.2.p
+	 */
+	protected function _add_screen_options_contact_list()
+	{
+		$page_title              = $this->_admin_page_title;
+		$this->_admin_page_title = esc_html__('Contacts', 'event_espresso');
+		$this->_per_page_screen_option();
+		$this->_admin_page_title = $page_title;
+	}
+
+
+	public function load_scripts_styles()
+	{
+		// style
+		wp_register_style(
+			'espresso_reg',
+			REG_ASSETS_URL . 'espresso_registrations_admin.css',
+			['ee-admin-css'],
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('espresso_reg');
+		// script
+		wp_register_script(
+			'espresso_reg',
+			REG_ASSETS_URL . 'espresso_registrations_admin.js',
+			['jquery-ui-datepicker', 'jquery-ui-draggable', 'ee_admin_js'],
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_enqueue_script('espresso_reg');
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @since 4.10.2.p
+	 */
+	public function load_scripts_styles_edit_attendee()
+	{
+		// stuff to only show up on our attendee edit details page.
+		$attendee_details_translations = [
+			'att_publish_text' => sprintf(
+			/* translators: The date and time */
+				wp_strip_all_tags(__('Created on: %s', 'event_espresso')),
+				'<b>' . $this->_cpt_model_obj->get_datetime('ATT_created') . '</b>'
+			),
+		];
+		wp_localize_script('espresso_reg', 'ATTENDEE_DETAILS', $attendee_details_translations);
+		wp_enqueue_script('jquery-validate');
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @since 4.10.2.p
+	 */
+	public function load_scripts_styles_view_registration()
+	{
+		// styles
+		wp_enqueue_style('espresso-ui-theme');
+		// scripts
+		$this->_get_reg_custom_questions_form($this->_registration->ID());
+		$this->_reg_custom_questions_form->wp_enqueue_scripts();
+	}
+
+
+	public function load_scripts_styles_contact_list()
+	{
+		wp_dequeue_style('espresso_reg');
+		wp_register_style(
+			'espresso_att',
+			REG_ASSETS_URL . 'espresso_attendees_admin.css',
+			['ee-admin-css'],
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('espresso_att');
+	}
+
+
+	public function load_scripts_styles_new_registration()
+	{
+		wp_register_script(
+			'ee-spco-for-admin',
+			REG_ASSETS_URL . 'spco_for_admin.js',
+			['underscore', 'jquery'],
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_enqueue_script('ee-spco-for-admin');
+		add_filter('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true');
+		EE_Form_Section_Proper::wp_enqueue_scripts();
+		EED_Ticket_Selector::load_tckt_slctr_assets();
+		EE_Datepicker_Input::enqueue_styles_and_scripts();
+	}
+
+
+	public function AHEE__EE_Admin_Page__route_admin_request_resend_registration()
+	{
+		add_filter('FHEE_load_EE_messages', '__return_true');
+	}
+
+
+	public function AHEE__EE_Admin_Page__route_admin_request_approve_registration()
+	{
+		add_filter('FHEE_load_EE_messages', '__return_true');
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @since 4.10.2.p
+	 */
+	protected function _set_list_table_views_default()
+	{
+		// for notification related bulk actions we need to make sure only active messengers have an option.
+		EED_Messages::set_autoloaders();
+		/** @type EE_Message_Resource_Manager $message_resource_manager */
+		$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$active_mts               = $message_resource_manager->list_of_active_message_types();
+		// key= bulk_action_slug, value= message type.
+		$match_array = [
+			'approve_registrations'    => 'registration',
+			'decline_registrations'    => 'declined_registration',
+			'pending_registrations'    => 'pending_approval',
+			'no_approve_registrations' => 'not_approved_registration',
+			'cancel_registrations'     => 'cancelled_registration',
+		];
+		$can_send    = EE_Registry::instance()->CAP->current_user_can(
+			'ee_send_message',
+			'batch_send_messages'
+		);
+		/** setup reg status bulk actions **/
+		$def_reg_status_actions['approve_registrations'] = esc_html__('Approve Registrations', 'event_espresso');
+		if ($can_send && in_array($match_array['approve_registrations'], $active_mts, true)) {
+			$def_reg_status_actions['approve_and_notify_registrations'] = esc_html__(
+				'Approve and Notify Registrations',
+				'event_espresso'
+			);
+		}
+		$def_reg_status_actions['decline_registrations'] = esc_html__('Decline Registrations', 'event_espresso');
+		if ($can_send && in_array($match_array['decline_registrations'], $active_mts, true)) {
+			$def_reg_status_actions['decline_and_notify_registrations'] = esc_html__(
+				'Decline and Notify Registrations',
+				'event_espresso'
+			);
+		}
+		$def_reg_status_actions['pending_registrations'] = esc_html__(
+			'Set Registrations to Pending Payment',
+			'event_espresso'
+		);
+		if ($can_send && in_array($match_array['pending_registrations'], $active_mts, true)) {
+			$def_reg_status_actions['pending_and_notify_registrations'] = esc_html__(
+				'Set Registrations to Pending Payment and Notify',
+				'event_espresso'
+			);
+		}
+		$def_reg_status_actions['no_approve_registrations'] = esc_html__(
+			'Set Registrations to Not Approved',
+			'event_espresso'
+		);
+		if ($can_send && in_array($match_array['no_approve_registrations'], $active_mts, true)) {
+			$def_reg_status_actions['no_approve_and_notify_registrations'] = esc_html__(
+				'Set Registrations to Not Approved and Notify',
+				'event_espresso'
+			);
+		}
+		$def_reg_status_actions['cancel_registrations'] = esc_html__('Cancel Registrations', 'event_espresso');
+		if ($can_send && in_array($match_array['cancel_registrations'], $active_mts, true)) {
+			$def_reg_status_actions['cancel_and_notify_registrations'] = esc_html__(
+				'Cancel Registrations and Notify',
+				'event_espresso'
+			);
+		}
+		$def_reg_status_actions = apply_filters(
+			'FHEE__Registrations_Admin_Page___set_list_table_views_default__def_reg_status_actions_array',
+			$def_reg_status_actions,
+			$active_mts,
+			$can_send
+		);
+
+		$this->_views = [
+			'all'   => [
+				'slug'        => 'all',
+				'label'       => esc_html__('View All Registrations', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array_merge(
+					$def_reg_status_actions,
+					[
+						'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'),
+					]
+				),
+			],
+			'month' => [
+				'slug'        => 'month',
+				'label'       => esc_html__('This Month', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array_merge(
+					$def_reg_status_actions,
+					[
+						'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'),
+					]
+				),
+			],
+			'today' => [
+				'slug'        => 'today',
+				'label'       => sprintf(
+					esc_html__('Today - %s', 'event_espresso'),
+					date('M d, Y', current_time('timestamp'))
+				),
+				'count'       => 0,
+				'bulk_action' => array_merge(
+					$def_reg_status_actions,
+					[
+						'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'),
+					]
+				),
+			],
+		];
+		if (
+			EE_Registry::instance()->CAP->current_user_can(
+				'ee_delete_registrations',
+				'espresso_registrations_delete_registration'
+			)
+		) {
+			$this->_views['incomplete'] = [
+				'slug'        => 'incomplete',
+				'label'       => esc_html__('Incomplete', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => [
+					'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'),
+				],
+			];
+			$this->_views['trash']      = [
+				'slug'        => 'trash',
+				'label'       => esc_html__('Trash', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => [
+					'restore_registrations' => esc_html__('Restore Registrations', 'event_espresso'),
+					'delete_registrations'  => esc_html__('Delete Registrations Permanently', 'event_espresso'),
+				],
+			];
+		}
+	}
+
+
+	protected function _set_list_table_views_contact_list()
+	{
+		$this->_views = [
+			'in_use' => [
+				'slug'        => 'in_use',
+				'label'       => esc_html__('In Use', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => [
+					'trash_attendees' => esc_html__('Move to Trash', 'event_espresso'),
+				],
+			],
+		];
+		if (
+			EE_Registry::instance()->CAP->current_user_can(
+				'ee_delete_contacts',
+				'espresso_registrations_trash_attendees'
+			)
+		) {
+			$this->_views['trash'] = [
+				'slug'        => 'trash',
+				'label'       => esc_html__('Trash', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => [
+					'restore_attendees' => esc_html__('Restore from Trash', 'event_espresso'),
+				],
+			];
+		}
+	}
+
+
+	/**
+	 * @return array
+	 * @throws EE_Error
+	 */
+	protected function _registration_legend_items()
+	{
+		$fc_items = [
+			'star-icon'        => [
+				'class' => 'dashicons dashicons-star-filled gold-icon',
+				'desc'  => esc_html__('This is the Primary Registrant', 'event_espresso'),
+			],
+			'view_details'     => [
+				'class' => 'dashicons dashicons-clipboard',
+				'desc'  => esc_html__('View Registration Details', 'event_espresso'),
+			],
+			'edit_attendee'    => [
+				'class' => 'dashicons dashicons-admin-users',
+				'desc'  => esc_html__('Edit Contact Details', 'event_espresso'),
+			],
+			'view_transaction' => [
+				'class' => 'dashicons dashicons-cart',
+				'desc'  => esc_html__('View Transaction Details', 'event_espresso'),
+			],
+			'view_invoice'     => [
+				'class' => 'dashicons dashicons-media-spreadsheet',
+				'desc'  => esc_html__('View Transaction Invoice', 'event_espresso'),
+			],
+		];
+		if (
+			EE_Registry::instance()->CAP->current_user_can(
+				'ee_send_message',
+				'espresso_registrations_resend_registration'
+			)
+		) {
+			$fc_items['resend_registration'] = [
+				'class' => 'dashicons dashicons-email-alt',
+				'desc'  => esc_html__('Resend Registration Details', 'event_espresso'),
+			];
+		} else {
+			$fc_items['blank'] = ['class' => 'blank', 'desc' => ''];
+		}
+		if (
+			EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_global_messages',
+				'view_filtered_messages'
+			)
+		) {
+			$related_for_icon = EEH_MSG_Template::get_message_action_icon('see_notifications_for');
+			if (is_array($related_for_icon) && isset($related_for_icon['css_class'], $related_for_icon['label'])) {
+				$fc_items['view_related_messages'] = [
+					'class' => $related_for_icon['css_class'],
+					'desc'  => $related_for_icon['label'],
+				];
+			}
+		}
+		$sc_items = [
+			'approved_status'   => [
+				'class' => 'ee-status-legend ee-status-bg--' . EEM_Registration::status_id_approved,
+				'desc'  => EEH_Template::pretty_status(
+					EEM_Registration::status_id_approved,
+					false,
+					'sentence'
+				),
+			],
+			'pending_status'    => [
+				'class' => 'ee-status-legend ee-status-bg--' . EEM_Registration::status_id_pending_payment,
+				'desc'  => EEH_Template::pretty_status(
+					EEM_Registration::status_id_pending_payment,
+					false,
+					'sentence'
+				),
+			],
+			'wait_list'         => [
+				'class' => 'ee-status-legend ee-status-bg--' . EEM_Registration::status_id_wait_list,
+				'desc'  => EEH_Template::pretty_status(
+					EEM_Registration::status_id_wait_list,
+					false,
+					'sentence'
+				),
+			],
+			'incomplete_status' => [
+				'class' => 'ee-status-legend ee-status-bg--' . EEM_Registration::status_id_incomplete,
+				'desc'  => EEH_Template::pretty_status(
+					EEM_Registration::status_id_incomplete,
+					false,
+					'sentence'
+				),
+			],
+			'not_approved'      => [
+				'class' => 'ee-status-legend ee-status-bg--' . EEM_Registration::status_id_not_approved,
+				'desc'  => EEH_Template::pretty_status(
+					EEM_Registration::status_id_not_approved,
+					false,
+					'sentence'
+				),
+			],
+			'declined_status'   => [
+				'class' => 'ee-status-legend ee-status-bg--' . EEM_Registration::status_id_declined,
+				'desc'  => EEH_Template::pretty_status(
+					EEM_Registration::status_id_declined,
+					false,
+					'sentence'
+				),
+			],
+			'cancelled_status'  => [
+				'class' => 'ee-status-legend ee-status-bg--' . EEM_Registration::status_id_cancelled,
+				'desc'  => EEH_Template::pretty_status(
+					EEM_Registration::status_id_cancelled,
+					false,
+					'sentence'
+				),
+			],
+		];
+		return array_merge($fc_items, $sc_items);
+	}
+
+
+
+	/***************************************        REGISTRATION OVERVIEW        **************************************/
+
+
+	/**
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _registrations_overview_list_table()
+	{
+		$this->appendAddNewRegistrationButtonToPageTitle();
+		$header_text                  = '';
+		$admin_page_header_decorators = [
+			'EventEspresso\core\domain\services\admin\registrations\list_table\page_header\AttendeeFilterHeader',
+			'EventEspresso\core\domain\services\admin\registrations\list_table\page_header\EventFilterHeader',
+			'EventEspresso\core\domain\services\admin\registrations\list_table\page_header\DateFilterHeader',
+			'EventEspresso\core\domain\services\admin\registrations\list_table\page_header\TicketFilterHeader',
+		];
+		foreach ($admin_page_header_decorators as $admin_page_header_decorator) {
+			$filter_header_decorator = $this->loader->getNew($admin_page_header_decorator);
+			$header_text = $filter_header_decorator->getHeaderText($header_text);
+		}
+		$this->_template_args['before_list_table']  = $header_text;
+		$this->_template_args['after_list_table']  = $this->_display_legend($this->_registration_legend_items());
+		$this->display_admin_list_table_page_with_no_sidebar();
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function appendAddNewRegistrationButtonToPageTitle()
+	{
+		$EVT_ID = $this->request->getRequestParam('event_id', 0, 'int');
+		if (
+			$EVT_ID
+			&& EE_Registry::instance()->CAP->current_user_can(
+				'ee_edit_registrations',
+				'espresso_registrations_new_registration',
+				$EVT_ID
+			)
+		) {
+			$this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
+				'new_registration',
+				'add-registrant',
+				['event_id' => $EVT_ID],
+				'add-new-h2'
+			);
+		}
+	}
+
+
+	/**
+	 * This sets the _registration property for the registration details screen
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _set_registration_object()
+	{
+		// get out if we've already set the object
+		if ($this->_registration instanceof EE_Registration) {
+			return;
+		}
+		$REG_ID = $this->request->getRequestParam('_REG_ID', 0, 'int');
+		if ($this->_registration = $this->getRegistrationModel()->get_one_by_ID($REG_ID)) {
+			return;
+		}
+		$error_msg = sprintf(
+			esc_html__(
+				'An error occurred and the details for Registration ID #%s could not be retrieved.',
+				'event_espresso'
+			),
+			$REG_ID
+		);
+		EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
+		$this->_registration = null;
+	}
+
+
+	/**
+	 * Used to retrieve registrations for the list table.
+	 *
+	 * @param int  $per_page
+	 * @param bool $count
+	 * @param bool $this_month
+	 * @param bool $today
+	 * @return EE_Registration[]|int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_registrations(
+		$per_page = 10,
+		$count = false,
+		$this_month = false,
+		$today = false
+	) {
+		if ($this_month) {
+			$this->request->setRequestParam('status', 'month');
+		}
+		if ($today) {
+			$this->request->setRequestParam('status', 'today');
+		}
+		$query_params = $this->_get_registration_query_parameters($this->request->requestParams(), $per_page, $count);
+		/**
+		 * Override the default groupby added by EEM_Base so that sorts with multiple order bys work as expected
+		 *
+		 * @link https://events.codebasehq.com/projects/event-espresso/tickets/10093
+		 * @see  https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+		 *                      or if you have the development copy of EE you can view this at the path:
+		 *                      /docs/G--Model-System/model-query-params.md
+		 */
+		$query_params['group_by'] = '';
+
+		return $count
+			? $this->getRegistrationModel()->count($query_params)
+			/** @type EE_Registration[] */
+			: $this->getRegistrationModel()->get_all($query_params);
+	}
+
+
+	/**
+	 * Retrieves the query parameters to be used by the Registration model for getting registrations.
+	 * Note: this listens to values on the request for some of the query parameters.
+	 *
+	 * @param array $request
+	 * @param int   $per_page
+	 * @param bool  $count
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _get_registration_query_parameters(
+		$request = [],
+		$per_page = 10,
+		$count = false
+	) {
+		/** @var EventEspresso\core\domain\services\admin\registrations\list_table\QueryBuilder $list_table_query_builder */
+		$list_table_query_builder = $this->loader->getNew(
+			'EventEspresso\core\domain\services\admin\registrations\list_table\QueryBuilder',
+			[null, null, $request]
+		);
+		return $list_table_query_builder->getQueryParams($per_page, $count);
+	}
+
+
+	public function get_registration_status_array()
+	{
+		return self::$_reg_status;
+	}
+
+
+
+
+	/***************************************        REGISTRATION DETAILS        ***************************************/
+	/**
+	 * generates HTML for the View Registration Details Admin page
+	 *
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws EntityNotFoundException
+	 * @throws ReflectionException
+	 */
+	protected function _registration_details()
+	{
+		$this->_template_args = [];
+		$this->_set_registration_object();
+		if (is_object($this->_registration)) {
+			$transaction                                   = $this->_registration->transaction()
+				? $this->_registration->transaction()
+				: EE_Transaction::new_instance();
+			$this->_session                                = $transaction->session_data();
+			$event_id                                      = $this->_registration->event_ID();
+			$this->_template_args['reg_nmbr']['value']     = $this->_registration->ID();
+			$this->_template_args['reg_nmbr']['label']     = esc_html__('Registration Number', 'event_espresso');
+			$this->_template_args['reg_datetime']['value'] = $this->_registration->get_i18n_datetime('REG_date');
+			$this->_template_args['reg_datetime']['label'] = esc_html__('Date', 'event_espresso');
+			$this->_template_args['grand_total']           = $transaction->total();
+			$this->_template_args['currency_sign']         = EE_Registry::instance()->CFG->currency->sign;
+			// link back to overview
+			$this->_template_args['reg_overview_url']            = REG_ADMIN_URL;
+			$this->_template_args['registration']                = $this->_registration;
+			$this->_template_args['filtered_registrations_link'] = EE_Admin_Page::add_query_args_and_nonce(
+				[
+					'action'   => 'default',
+					'event_id' => $event_id,
+				],
+				REG_ADMIN_URL
+			);
+			$this->_template_args['filtered_transactions_link']  = EE_Admin_Page::add_query_args_and_nonce(
+				[
+					'action' => 'default',
+					'EVT_ID' => $event_id,
+					'page'   => 'espresso_transactions',
+				],
+				admin_url('admin.php')
+			);
+			$this->_template_args['event_link']                  = EE_Admin_Page::add_query_args_and_nonce(
+				[
+					'page'   => 'espresso_events',
+					'action' => 'edit',
+					'post'   => $event_id,
+				],
+				admin_url('admin.php')
+			);
+			// next and previous links
+			$next_reg                                      = $this->_registration->next(
+				null,
+				[],
+				'REG_ID'
+			);
+			$this->_template_args['next_registration']     = $next_reg
+				? $this->_next_link(
+					EE_Admin_Page::add_query_args_and_nonce(
+						[
+							'action'  => 'view_registration',
+							'_REG_ID' => $next_reg['REG_ID'],
+						],
+						REG_ADMIN_URL
+					),
+					'dashicons dashicons-arrow-right ee-icon-size-22'
+				)
+				: '';
+			$previous_reg                                  = $this->_registration->previous(
+				null,
+				[],
+				'REG_ID'
+			);
+			$this->_template_args['previous_registration'] = $previous_reg
+				? $this->_previous_link(
+					EE_Admin_Page::add_query_args_and_nonce(
+						[
+							'action'  => 'view_registration',
+							'_REG_ID' => $previous_reg['REG_ID'],
+						],
+						REG_ADMIN_URL
+					),
+					'dashicons dashicons-arrow-left ee-icon-size-22'
+				)
+				: '';
+			// grab header
+			$template_path                             = REG_TEMPLATE_PATH . 'reg_admin_details_header.template.php';
+			$this->_template_args['REG_ID']            = $this->_registration->ID();
+			$this->_template_args['admin_page_header'] = EEH_Template::display_template(
+				$template_path,
+				$this->_template_args,
+				true
+			);
+		} else {
+			$this->_template_args['admin_page_header'] = '';
+			$this->_display_espresso_notices();
+		}
+		// the details template wrapper
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @since 4.10.2.p
+	 */
+	protected function _registration_details_metaboxes()
+	{
+		do_action('AHEE__Registrations_Admin_Page___registration_details_metabox__start', $this);
+		$this->_set_registration_object();
+		$attendee = $this->_registration instanceof EE_Registration ? $this->_registration->attendee() : null;
+		$this->addMetaBox(
+			'edit-reg-status-mbox',
+			esc_html__('Registration Status', 'event_espresso'),
+			[$this, 'set_reg_status_buttons_metabox'],
+			$this->_wp_page_slug
+		);
+		$this->addMetaBox(
+			'edit-reg-details-mbox',
+			'<span>' . esc_html__('Registration Details', 'event_espresso')
+			. '&nbsp;<span class="dashicons dashicons-clipboard"></span></span>',
+			[$this, '_reg_details_meta_box'],
+			$this->_wp_page_slug
+		);
+		if (
+			$attendee instanceof EE_Attendee
+			&& EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_registration',
+				'edit-reg-questions-mbox',
+				$this->_registration->ID()
+			)
+		) {
+			$this->addMetaBox(
+				'edit-reg-questions-mbox',
+				esc_html__('Registration Form Answers', 'event_espresso'),
+				[$this, '_reg_questions_meta_box'],
+				$this->_wp_page_slug
+			);
+		}
+		$this->addMetaBox(
+			'edit-reg-registrant-mbox',
+			esc_html__('Contact Details', 'event_espresso'),
+			[$this, '_reg_registrant_side_meta_box'],
+			$this->_wp_page_slug,
+			'side'
+		);
+		if ($this->_registration->group_size() > 1) {
+			$this->addMetaBox(
+				'edit-reg-attendees-mbox',
+				esc_html__('Other Registrations in this Transaction', 'event_espresso'),
+				[$this, '_reg_attendees_meta_box'],
+				$this->_wp_page_slug
+			);
+		}
+	}
+
+
+	/**
+	 * set_reg_status_buttons_metabox
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_reg_status_buttons_metabox()
+	{
+		$this->_set_registration_object();
+		$change_reg_status_form = $this->_generate_reg_status_change_form();
+		$output                 = $change_reg_status_form->form_open(
+			self::add_query_args_and_nonce(
+				[
+					'action' => 'change_reg_status',
+				],
+				REG_ADMIN_URL
+			)
+		);
+		$output                 .= $change_reg_status_form->get_html();
+		$output                 .= $change_reg_status_form->form_close();
+		echo wp_kses($output, AllowedTags::getWithFormTags());
+	}
+
+
+	/**
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws EntityNotFoundException
+	 * @throws ReflectionException
+	 */
+	protected function _generate_reg_status_change_form()
+	{
+		$reg_status_change_form_array = [
+			'name'            => 'reg_status_change_form',
+			'html_id'         => 'reg-status-change-form',
+			'layout_strategy' => new EE_Admin_Two_Column_Layout(),
+			'subsections'     => [
+				'return'         => new EE_Hidden_Input(
+					[
+						'name'    => 'return',
+						'default' => 'view_registration',
+					]
+				),
+				'REG_ID'         => new EE_Hidden_Input(
+					[
+						'name'    => 'REG_ID',
+						'default' => $this->_registration->ID(),
+					]
+				),
+			],
+		];
+		if (
+			EE_Registry::instance()->CAP->current_user_can(
+				'ee_edit_registration',
+				'toggle_registration_status',
+				$this->_registration->ID()
+			)
+		) {
+			$reg_status_change_form_array['subsections']['reg_status']         = new EE_Select_Input(
+				$this->_get_reg_statuses(),
+				[
+					'html_label_text' => esc_html__('Change Registration Status to', 'event_espresso'),
+					'default'         => $this->_registration->status_ID(),
+				]
+			);
+			$reg_status_change_form_array['subsections']['send_notifications'] = new EE_Yes_No_Input(
+				[
+					'html_label_text' => esc_html__('Send Related Messages', 'event_espresso'),
+					'default'         => false,
+					'html_help_text'  => esc_html__(
+						'If set to "Yes", then the related messages will be sent to the registrant.',
+						'event_espresso'
+					),
+				]
+			);
+			$reg_status_change_form_array['subsections']['submit']             = new EE_Submit_Input(
+				[
+					'html_class'      => 'button--primary',
+					'html_label_text' => '&nbsp;',
+					'default'         => esc_html__('Update Registration Status', 'event_espresso'),
+				]
+			);
+		}
+		return new EE_Form_Section_Proper($reg_status_change_form_array);
+	}
+
+
+	/**
+	 * Returns an array of all the buttons for the various statuses and switch status actions
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws EntityNotFoundException
+	 */
+	protected function _get_reg_statuses()
+	{
+		$reg_status_array = $this->getRegistrationModel()->reg_status_array();
+		unset($reg_status_array[ EEM_Registration::status_id_incomplete ]);
+		// get current reg status
+		$current_status = $this->_registration->status_ID();
+		// is registration for free event? This will determine whether to display the pending payment option
+		if (
+			$current_status !== EEM_Registration::status_id_pending_payment
+			&& EEH_Money::compare_floats($this->_registration->ticket()->price(), 0.00)
+		) {
+			unset($reg_status_array[ EEM_Registration::status_id_pending_payment ]);
+		}
+		return $this->getStatusModel()->localized_status($reg_status_array, false, 'sentence');
+	}
+
+
+	/**
+	 * This method is used when using _REG_ID from request which may or may not be an array of reg_ids.
+	 *
+	 * @param bool $status REG status given for changing registrations to.
+	 * @param bool $notify Whether to send messages notifications or not.
+	 * @return array (array with reg_id(s) updated and whether update was successful.
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	protected function _set_registration_status_from_request($status = false, $notify = false)
+	{
+		$REG_IDs = $this->request->requestParamIsSet('reg_status_change_form')
+			? $this->request->getRequestParam('reg_status_change_form[REG_ID]', [], 'int', true)
+			: $this->request->getRequestParam('_REG_ID', [], 'int', true);
+
+		// sanitize $REG_IDs
+		$REG_IDs = array_map('absint', $REG_IDs);
+		// and remove empty entries
+		$REG_IDs = array_filter($REG_IDs);
+
+		$result = $this->_set_registration_status($REG_IDs, $status, $notify);
+
+		/**
+		 * Set and filter $_req_data['_REG_ID'] for any potential future messages notifications.
+		 * Currently this value is used downstream by the _process_resend_registration method.
+		 *
+		 * @param int|array                $registration_ids The registration ids that have had their status changed successfully.
+		 * @param bool                     $status           The status registrations were changed to.
+		 * @param bool                     $success          If the status was changed successfully for all registrations.
+		 * @param Registrations_Admin_Page $admin_page_object
+		 */
+		$REG_ID = apply_filters(
+			'FHEE__Registrations_Admin_Page___set_registration_status_from_request__REG_IDs',
+			$result['REG_ID'],
+			$status,
+			$result['success'],
+			$this
+		);
+		$this->request->setRequestParam('_REG_ID', $REG_ID);
+
+		// notify?
+		if (
+			$notify
+			&& $result['success']
+			&& ! empty($REG_ID)
+			&& EE_Registry::instance()->CAP->current_user_can(
+				'ee_send_message',
+				'espresso_registrations_resend_registration'
+			)
+		) {
+			$this->_process_resend_registration();
+		}
+		return $result;
+	}
+
+
+	/**
+	 * Set the registration status for the given reg_id (which may or may not be an array, it gets typecast to an
+	 * array). Note, this method does NOT take care of possible notifications.  That is required by calling code.
+	 *
+	 * @param array  $REG_IDs
+	 * @param string $status
+	 * @param bool   $notify Used to indicate whether notification was requested or not.  This determines the context
+	 *                       slug sent with setting the registration status.
+	 * @return array (an array with 'success' key representing whether status change was successful, and 'REG_ID' as
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws EntityNotFoundException
+	 * @throws DomainException
+	 */
+	protected function _set_registration_status($REG_IDs = [], $status = '', $notify = false)
+	{
+		$success = false;
+		// typecast $REG_IDs
+		$REG_IDs = (array) $REG_IDs;
+		if (! empty($REG_IDs)) {
+			$success = true;
+			// set default status if none is passed
+			$status         = $status ?: EEM_Registration::status_id_pending_payment;
+			$status_context = $notify
+				? Domain::CONTEXT_REGISTRATION_STATUS_CHANGE_REGISTRATION_ADMIN_NOTIFY
+				: Domain::CONTEXT_REGISTRATION_STATUS_CHANGE_REGISTRATION_ADMIN;
+			// loop through REG_ID's and change status
+			foreach ($REG_IDs as $REG_ID) {
+				$registration = $this->getRegistrationModel()->get_one_by_ID($REG_ID);
+				if ($registration instanceof EE_Registration) {
+					$registration->set_status(
+						$status,
+						false,
+						new Context(
+							$status_context,
+							esc_html__(
+								'Manually triggered status change on a Registration Admin Page route.',
+								'event_espresso'
+							)
+						)
+					);
+					$result = $registration->save();
+					// verifying explicit fails because update *may* just return 0 for 0 rows affected
+					$success = $result !== false ? $success : false;
+				}
+			}
+		}
+
+		// return $success and processed registrations
+		return ['REG_ID' => $REG_IDs, 'success' => $success];
+	}
+
+
+	/**
+	 * Common logic for setting up success message and redirecting to appropriate route
+	 *
+	 * @param string $STS_ID status id for the registration changed to
+	 * @param bool   $notify indicates whether the _set_registration_status_from_request does notifications or not.
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	protected function _reg_status_change_return($STS_ID, $notify = false)
+	{
+		$result  = ! empty($STS_ID) ? $this->_set_registration_status_from_request($STS_ID, $notify)
+			: ['success' => false];
+		$success = isset($result['success']) && $result['success'];
+		// setup success message
+		if ($success) {
+			if (is_array($result['REG_ID']) && count($result['REG_ID']) === 1) {
+				$msg = sprintf(
+					esc_html__('Registration status has been set to %s', 'event_espresso'),
+					EEH_Template::pretty_status($STS_ID, false, 'lower')
+				);
+			} else {
+				$msg = sprintf(
+					esc_html__('Registrations have been set to %s.', 'event_espresso'),
+					EEH_Template::pretty_status($STS_ID, false, 'lower')
+				);
+			}
+			EE_Error::add_success($msg);
+		} else {
+			EE_Error::add_error(
+				esc_html__(
+					'Something went wrong, and the status was not changed',
+					'event_espresso'
+				),
+				__FILE__,
+				__LINE__,
+				__FUNCTION__
+			);
+		}
+		$return = $this->request->getRequestParam('return');
+		$route  = $return === 'view_registration'
+			? ['action' => 'view_registration', '_REG_ID' => reset($result['REG_ID'])]
+			: ['action' => 'default'];
+		$route  = $this->mergeExistingRequestParamsWithRedirectArgs($route);
+		$this->_redirect_after_action($success, '', '', $route, true);
+	}
+
+
+	/**
+	 * incoming reg status change from reg details page.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws DomainException
+	 */
+	protected function _change_reg_status()
+	{
+		$this->request->setRequestParam('return', 'view_registration');
+		// set notify based on whether the send notifications toggle is set or not
+		$notify     = $this->request->getRequestParam('reg_status_change_form[send_notifications]', false, 'bool');
+		$reg_status = $this->request->getRequestParam('reg_status_change_form[reg_status]', '');
+		$this->request->setRequestParam('reg_status_change_form[reg_status]', $reg_status);
+		switch ($reg_status) {
+			case EEM_Registration::status_id_approved:
+			case EEH_Template::pretty_status(EEM_Registration::status_id_approved, false, 'sentence'):
+				$this->approve_registration($notify);
+				break;
+			case EEM_Registration::status_id_pending_payment:
+			case EEH_Template::pretty_status(EEM_Registration::status_id_pending_payment, false, 'sentence'):
+				$this->pending_registration($notify);
+				break;
+			case EEM_Registration::status_id_not_approved:
+			case EEH_Template::pretty_status(EEM_Registration::status_id_not_approved, false, 'sentence'):
+				$this->not_approve_registration($notify);
+				break;
+			case EEM_Registration::status_id_declined:
+			case EEH_Template::pretty_status(EEM_Registration::status_id_declined, false, 'sentence'):
+				$this->decline_registration($notify);
+				break;
+			case EEM_Registration::status_id_cancelled:
+			case EEH_Template::pretty_status(EEM_Registration::status_id_cancelled, false, 'sentence'):
+				$this->cancel_registration($notify);
+				break;
+			case EEM_Registration::status_id_wait_list:
+			case EEH_Template::pretty_status(EEM_Registration::status_id_wait_list, false, 'sentence'):
+				$this->wait_list_registration($notify);
+				break;
+			case EEM_Registration::status_id_incomplete:
+			default:
+				$this->request->unSetRequestParam('return');
+				$this->_reg_status_change_return('');
+				break;
+		}
+	}
+
+
+	/**
+	 * Callback for bulk action routes.
+	 * Note: although we could just register the singular route callbacks for each bulk action route as well, this
+	 * method was chosen so there is one central place all the registration status bulk actions are going through.
+	 * Potentially, this provides an easier place to locate logic that is specific to these bulk actions (as opposed to
+	 * when an action is happening on just a single registration).
+	 *
+	 * @param      $action
+	 * @param bool $notify
+	 */
+	protected function bulk_action_on_registrations($action, $notify = false)
+	{
+		do_action(
+			'AHEE__Registrations_Admin_Page__bulk_action_on_registrations__before_execution',
+			$this,
+			$action,
+			$notify
+		);
+		$method = $action . '_registration';
+		if (method_exists($this, $method)) {
+			$this->$method($notify);
+		}
+	}
+
+
+	/**
+	 * approve_registration
+	 *
+	 * @param bool $notify whether or not to notify the registrant about their approval.
+	 * @return void
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws DomainException
+	 */
+	protected function approve_registration($notify = false)
+	{
+		$this->_reg_status_change_return(EEM_Registration::status_id_approved, $notify);
+	}
+
+
+	/**
+	 * decline_registration
+	 *
+	 * @param bool $notify whether or not to notify the registrant about their status change.
+	 * @return void
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws DomainException
+	 */
+	protected function decline_registration($notify = false)
+	{
+		$this->_reg_status_change_return(EEM_Registration::status_id_declined, $notify);
+	}
+
+
+	/**
+	 * cancel_registration
+	 *
+	 * @param bool $notify whether or not to notify the registrant about their status change.
+	 * @return void
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws DomainException
+	 */
+	protected function cancel_registration($notify = false)
+	{
+		$this->_reg_status_change_return(EEM_Registration::status_id_cancelled, $notify);
+	}
+
+
+	/**
+	 * not_approve_registration
+	 *
+	 * @param bool $notify whether or not to notify the registrant about their status change.
+	 * @return void
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws DomainException
+	 */
+	protected function not_approve_registration($notify = false)
+	{
+		$this->_reg_status_change_return(EEM_Registration::status_id_not_approved, $notify);
+	}
+
+
+	/**
+	 * decline_registration
+	 *
+	 * @param bool $notify whether or not to notify the registrant about their status change.
+	 * @return void
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws DomainException
+	 */
+	protected function pending_registration($notify = false)
+	{
+		$this->_reg_status_change_return(EEM_Registration::status_id_pending_payment, $notify);
+	}
+
+
+	/**
+	 * waitlist_registration
+	 *
+	 * @param bool $notify whether or not to notify the registrant about their status change.
+	 * @return void
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws DomainException
+	 */
+	protected function wait_list_registration($notify = false)
+	{
+		$this->_reg_status_change_return(EEM_Registration::status_id_wait_list, $notify);
+	}
+
+
+	/**
+	 * generates HTML for the Registration main meta box
+	 *
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws EntityNotFoundException
+	 */
+	public function _reg_details_meta_box()
+	{
+		EEH_Autoloader::register_line_item_display_autoloaders();
+		EEH_Autoloader::register_line_item_filter_autoloaders();
+		EE_Registry::instance()->load_helper('Line_Item');
+		$transaction    = $this->_registration->transaction() ? $this->_registration->transaction()
+			: EE_Transaction::new_instance();
+		$this->_session = $transaction->session_data();
+		$filters        = new EE_Line_Item_Filter_Collection();
+		$filters->add(new EE_Single_Registration_Line_Item_Filter($this->_registration));
+		$filters->add(new EE_Non_Zero_Line_Item_Filter());
+		$line_item_filter_processor              = new EE_Line_Item_Filter_Processor(
+			$filters,
+			$transaction->total_line_item()
+		);
+		$filtered_line_item_tree                 = $line_item_filter_processor->process();
+		$line_item_display                       = new EE_Line_Item_Display(
+			'reg_admin_table',
+			'EE_Admin_Table_Registration_Line_Item_Display_Strategy'
+		);
+		$this->_template_args['line_item_table'] = $line_item_display->display_line_item(
+			$filtered_line_item_tree,
+			['EE_Registration' => $this->_registration]
+		);
+		$attendee                                = $this->_registration->attendee();
+		if (
+			EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_transaction',
+				'espresso_transactions_view_transaction'
+			)
+		) {
+			$this->_template_args['view_transaction_button'] = EEH_Template::get_button_or_link(
+				EE_Admin_Page::add_query_args_and_nonce(
+					[
+						'action' => 'view_transaction',
+						'TXN_ID' => $transaction->ID(),
+					],
+					TXN_ADMIN_URL
+				),
+				esc_html__(' View Transaction', 'event_espresso'),
+				'button button--secondary right',
+				'dashicons dashicons-cart'
+			);
+		} else {
+			$this->_template_args['view_transaction_button'] = '';
+		}
+		if (
+			$attendee instanceof EE_Attendee
+			&& EE_Registry::instance()->CAP->current_user_can(
+				'ee_send_message',
+				'espresso_registrations_resend_registration'
+			)
+		) {
+			$this->_template_args['resend_registration_button'] = EEH_Template::get_button_or_link(
+				EE_Admin_Page::add_query_args_and_nonce(
+					[
+						'action'      => 'resend_registration',
+						'_REG_ID'     => $this->_registration->ID(),
+						'redirect_to' => 'view_registration',
+					],
+					REG_ADMIN_URL
+				),
+				esc_html__(' Resend Registration', 'event_espresso'),
+				'button button--secondary right',
+				'dashicons dashicons-email-alt'
+			);
+		} else {
+			$this->_template_args['resend_registration_button'] = '';
+		}
+		$this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign;
+		$payment                               = $transaction->get_first_related('Payment');
+		$payment                               = ! $payment instanceof EE_Payment
+			? EE_Payment::new_instance()
+			: $payment;
+		$payment_method                        = $payment->get_first_related('Payment_Method');
+		$payment_method                        = ! $payment_method instanceof EE_Payment_Method
+			? EE_Payment_Method::new_instance()
+			: $payment_method;
+		$reg_details                           = [
+			'payment_method'       => $payment_method->name(),
+			'response_msg'         => $payment->gateway_response(),
+			'registration_id'      => $this->_registration->get('REG_code'),
+			'registration_session' => $this->_registration->session_ID(),
+			'ip_address'           => isset($this->_session['ip_address']) ? $this->_session['ip_address'] : '',
+			'user_agent'           => isset($this->_session['user_agent']) ? $this->_session['user_agent'] : '',
+		];
+		if (isset($reg_details['registration_id'])) {
+			$this->_template_args['reg_details']['registration_id']['value'] = $reg_details['registration_id'];
+			$this->_template_args['reg_details']['registration_id']['label'] = esc_html__(
+				'Registration ID',
+				'event_espresso'
+			);
+			$this->_template_args['reg_details']['registration_id']['class'] = 'regular-text';
+		}
+		if (isset($reg_details['payment_method'])) {
+			$this->_template_args['reg_details']['payment_method']['value'] = $reg_details['payment_method'];
+			$this->_template_args['reg_details']['payment_method']['label'] = esc_html__(
+				'Most Recent Payment Method',
+				'event_espresso'
+			);
+			$this->_template_args['reg_details']['payment_method']['class'] = 'regular-text';
+			$this->_template_args['reg_details']['response_msg']['value']   = $reg_details['response_msg'];
+			$this->_template_args['reg_details']['response_msg']['label']   = esc_html__(
+				'Payment method response',
+				'event_espresso'
+			);
+			$this->_template_args['reg_details']['response_msg']['class']   = 'regular-text';
+		}
+		$this->_template_args['reg_details']['registration_session']['value'] = $reg_details['registration_session'];
+		$this->_template_args['reg_details']['registration_session']['label'] = esc_html__(
+			'Registration Session',
+			'event_espresso'
+		);
+		$this->_template_args['reg_details']['registration_session']['class'] = 'regular-text';
+		$this->_template_args['reg_details']['ip_address']['value']           = $reg_details['ip_address'];
+		$this->_template_args['reg_details']['ip_address']['label']           = esc_html__(
+			'Registration placed from IP',
+			'event_espresso'
+		);
+		$this->_template_args['reg_details']['ip_address']['class']           = 'regular-text';
+		$this->_template_args['reg_details']['user_agent']['value']           = $reg_details['user_agent'];
+		$this->_template_args['reg_details']['user_agent']['label']           = esc_html__(
+			'Registrant User Agent',
+			'event_espresso'
+		);
+		$this->_template_args['reg_details']['user_agent']['class']           = 'large-text';
+		$this->_template_args['event_link']                                   = EE_Admin_Page::add_query_args_and_nonce(
+			[
+				'action'   => 'default',
+				'event_id' => $this->_registration->event_ID(),
+			],
+			REG_ADMIN_URL
+		);
+
+		$this->_template_args['REG_ID'] = $this->_registration->ID();
+		$this->_template_args['event_id'] = $this->_registration->event_ID();
+
+		$template_path = REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_details.template.php';
+		EEH_Template::display_template($template_path, $this->_template_args); // already escaped
+	}
+
+
+	/**
+	 * generates HTML for the Registration Questions meta box.
+	 * If pre-4.8.32.rc.000 hooks are used, uses old methods (with its filters),
+	 * otherwise uses new forms system
+	 *
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function _reg_questions_meta_box()
+	{
+		// allow someone to override this method entirely
+		if (
+			apply_filters(
+				'FHEE__Registrations_Admin_Page___reg_questions_meta_box__do_default',
+				true,
+				$this,
+				$this->_registration
+			)
+		) {
+			$form = $this->_get_reg_custom_questions_form(
+				$this->_registration->ID()
+			);
+
+			$this->_template_args['att_questions'] = count($form->subforms()) > 0
+				? $form->get_html_and_js()
+				: '';
+
+			$this->_template_args['reg_questions_form_action'] = 'edit_registration';
+			$this->_template_args['REG_ID'] = $this->_registration->ID();
+			$template_path = REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_questions.template.php';
+			EEH_Template::display_template($template_path, $this->_template_args);
+		}
+	}
+
+
+	/**
+	 * form_before_question_group
+	 *
+	 * @param string $output
+	 * @return        string
+	 * @deprecated    as of 4.8.32.rc.000
+	 */
+	public function form_before_question_group($output)
+	{
+		EE_Error::doing_it_wrong(
+			__CLASS__ . '::' . __FUNCTION__,
+			esc_html__(
+				'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.',
+				'event_espresso'
+			),
+			'4.8.32.rc.000'
+		);
+		return '
 	<table class="form-table ee-width-100">
 		<tbody>
 			';
-    }
-
-
-    /**
-     * form_after_question_group
-     *
-     * @param string $output
-     * @return        string
-     * @deprecated    as of 4.8.32.rc.000
-     */
-    public function form_after_question_group($output)
-    {
-        EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
-            esc_html__(
-                'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.',
-                'event_espresso'
-            ),
-            '4.8.32.rc.000'
-        );
-        return '
+	}
+
+
+	/**
+	 * form_after_question_group
+	 *
+	 * @param string $output
+	 * @return        string
+	 * @deprecated    as of 4.8.32.rc.000
+	 */
+	public function form_after_question_group($output)
+	{
+		EE_Error::doing_it_wrong(
+			__CLASS__ . '::' . __FUNCTION__,
+			esc_html__(
+				'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.',
+				'event_espresso'
+			),
+			'4.8.32.rc.000'
+		);
+		return '
 			<tr class="hide-if-no-js">
 				<th> </th>
 				<td class="reg-admin-edit-attendee-question-td">
 					<a class="reg-admin-edit-attendee-question-lnk" href="#" title="'
-               . esc_attr__('click to edit question', 'event_espresso')
-               . '">
+			   . esc_attr__('click to edit question', 'event_espresso')
+			   . '">
 						<span class="reg-admin-edit-question-group-spn lt-grey-txt">'
-               . esc_html__('edit the above question group', 'event_espresso')
-               . '</span>
+			   . esc_html__('edit the above question group', 'event_espresso')
+			   . '</span>
 						<div class="dashicons dashicons-edit"></div>
 					</a>
 				</td>
@@ -2230,636 +2230,636 @@ 
 		</tbody>
 	</table>
 ';
-    }
-
-
-    /**
-     * form_form_field_label_wrap
-     *
-     * @param string $label
-     * @return        string
-     * @deprecated    as of 4.8.32.rc.000
-     */
-    public function form_form_field_label_wrap($label)
-    {
-        EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
-            esc_html__(
-                'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.',
-                'event_espresso'
-            ),
-            '4.8.32.rc.000'
-        );
-        return '
+	}
+
+
+	/**
+	 * form_form_field_label_wrap
+	 *
+	 * @param string $label
+	 * @return        string
+	 * @deprecated    as of 4.8.32.rc.000
+	 */
+	public function form_form_field_label_wrap($label)
+	{
+		EE_Error::doing_it_wrong(
+			__CLASS__ . '::' . __FUNCTION__,
+			esc_html__(
+				'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.',
+				'event_espresso'
+			),
+			'4.8.32.rc.000'
+		);
+		return '
 			<tr>
 				<th>
 					' . $label . '
 				</th>';
-    }
-
-
-    /**
-     * form_form_field_input__wrap
-     *
-     * @param string $input
-     * @return        string
-     * @deprecated    as of 4.8.32.rc.000
-     */
-    public function form_form_field_input__wrap($input)
-    {
-        EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
-            esc_html__(
-                'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.',
-                'event_espresso'
-            ),
-            '4.8.32.rc.000'
-        );
-        return '
+	}
+
+
+	/**
+	 * form_form_field_input__wrap
+	 *
+	 * @param string $input
+	 * @return        string
+	 * @deprecated    as of 4.8.32.rc.000
+	 */
+	public function form_form_field_input__wrap($input)
+	{
+		EE_Error::doing_it_wrong(
+			__CLASS__ . '::' . __FUNCTION__,
+			esc_html__(
+				'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.',
+				'event_espresso'
+			),
+			'4.8.32.rc.000'
+		);
+		return '
 				<td class="reg-admin-attendee-questions-input-td disabled-input">
 					' . $input . '
 				</td>
 			</tr>';
-    }
-
-
-    /**
-     * Updates the registration's custom questions according to the form info, if the form is submitted.
-     * If it's not a post, the "view_registrations" route will be called next on the SAME request
-     * to display the page
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _update_attendee_registration_form()
-    {
-        do_action('AHEE__Registrations_Admin_Page___update_attendee_registration_form__start', $this);
-        if ($_SERVER['REQUEST_METHOD'] === 'POST') {
-            $REG_ID  = $this->request->getRequestParam('_REG_ID', 0, 'int');
-            $success = $this->_save_reg_custom_questions_form($REG_ID);
-            if ($success) {
-                $what  = esc_html__('Registration Form', 'event_espresso');
-                $route = $REG_ID
-                    ? ['action' => 'view_registration', '_REG_ID' => $REG_ID]
-                    : ['action' => 'default'];
-                $this->_redirect_after_action(true, $what, esc_html__('updated', 'event_espresso'), $route);
-            }
-        }
-    }
-
-
-    /**
-     * Gets the form for saving registrations custom questions (if done
-     * previously retrieves the cached form object, which may have validation errors in it)
-     *
-     * @param int $REG_ID
-     * @return EE_Registration_Custom_Questions_Form
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _get_reg_custom_questions_form($REG_ID)
-    {
-        if (! $this->_reg_custom_questions_form) {
-            require_once(REG_ADMIN . 'form_sections/EE_Registration_Custom_Questions_Form.form.php');
-            $this->_reg_custom_questions_form = new EE_Registration_Custom_Questions_Form(
-                $this->getRegistrationModel()->get_one_by_ID($REG_ID)
-            );
-            $this->_reg_custom_questions_form->_construct_finalize(null, null);
-        }
-        return $this->_reg_custom_questions_form;
-    }
-
-
-    /**
-     * Saves
-     *
-     * @param bool $REG_ID
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function _save_reg_custom_questions_form($REG_ID = 0)
-    {
-        if (! $REG_ID) {
-            EE_Error::add_error(
-                esc_html__(
-                    'An error occurred. No registration ID was received.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        $form = $this->_get_reg_custom_questions_form($REG_ID);
-        $form->receive_form_submission($this->request->requestParams());
-        $success = false;
-        if ($form->is_valid()) {
-            foreach ($form->subforms() as $question_group_form) {
-                foreach ($question_group_form->inputs() as $question_id => $input) {
-                    $where_conditions    = [
-                        'QST_ID' => $question_id,
-                        'REG_ID' => $REG_ID,
-                    ];
-                    $possibly_new_values = [
-                        'ANS_value' => $input->normalized_value(),
-                    ];
-                    $answer              = EEM_Answer::instance()->get_one([$where_conditions]);
-                    if ($answer instanceof EE_Answer) {
-                        $success = $answer->save($possibly_new_values);
-                    } else {
-                        // insert it then
-                        $cols_n_vals = array_merge($where_conditions, $possibly_new_values);
-                        $answer      = EE_Answer::new_instance($cols_n_vals);
-                        $success     = $answer->save();
-                    }
-                }
-            }
-        } else {
-            EE_Error::add_error($form->get_validation_error_string(), __FILE__, __FUNCTION__, __LINE__);
-        }
-        return $success;
-    }
-
-
-    /**
-     * generates HTML for the Registration main meta box
-     *
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function _reg_attendees_meta_box()
-    {
-        $REG = $this->getRegistrationModel();
-        // get all other registrations on this transaction, and cache
-        // the attendees for them so we don't have to run another query using force_join
-        $registrations                           = $REG->get_all(
-            [
-                [
-                    'TXN_ID' => $this->_registration->transaction_ID(),
-                    'REG_ID' => ['!=', $this->_registration->ID()],
-                ],
-                'force_join'               => ['Attendee'],
-                'default_where_conditions' => 'other_models_only',
-            ]
-        );
-        $this->_template_args['attendees']       = [];
-        $this->_template_args['attendee_notice'] = '';
-        if (
-            empty($registrations)
-            || (is_array($registrations)
-                && ! EEH_Array::get_one_item_from_array($registrations))
-        ) {
-            EE_Error::add_error(
-                esc_html__(
-                    'There are no records attached to this registration. Something may have gone wrong with the registration',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $this->_template_args['attendee_notice'] = EE_Error::get_notices();
-        } else {
-            $att_nmbr = 1;
-            foreach ($registrations as $registration) {
-                /* @var $registration EE_Registration */
-                $attendee                                                      = $registration->attendee()
-                    ? $registration->attendee()
-                    : $this->getAttendeeModel()->create_default_object();
-                $this->_template_args['attendees'][ $att_nmbr ]['STS_ID']      = $registration->status_ID();
-                $this->_template_args['attendees'][ $att_nmbr ]['fname']       = $attendee->fname();
-                $this->_template_args['attendees'][ $att_nmbr ]['lname']       = $attendee->lname();
-                $this->_template_args['attendees'][ $att_nmbr ]['email']       = $attendee->email();
-                $this->_template_args['attendees'][ $att_nmbr ]['final_price'] = $registration->final_price();
-                $this->_template_args['attendees'][ $att_nmbr ]['address']     = implode(
-                    ', ',
-                    $attendee->full_address_as_array()
-                );
-                $this->_template_args['attendees'][ $att_nmbr ]['att_link']    = self::add_query_args_and_nonce(
-                    [
-                        'action' => 'edit_attendee',
-                        'post'   => $attendee->ID(),
-                    ],
-                    REG_ADMIN_URL
-                );
-                $this->_template_args['attendees'][ $att_nmbr ]['event_name']  =
-                    $registration->event_obj() instanceof EE_Event
-                        ? $registration->event_obj()->name()
-                        : '';
-                $att_nmbr++;
-            }
-            $this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign;
-        }
-        $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_attendees.template.php';
-        EEH_Template::display_template($template_path, $this->_template_args);
-    }
-
-
-    /**
-     * generates HTML for the Edit Registration side meta box
-     *
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function _reg_registrant_side_meta_box()
-    {
-        /*@var $attendee EE_Attendee */
-        $att_check = $this->_registration->attendee();
-        $attendee  = $att_check instanceof EE_Attendee
-            ? $att_check
-            : $this->getAttendeeModel()->create_default_object();
-        // now let's determine if this is not the primary registration.  If it isn't then we set the
-        // primary_registration object for reference BUT ONLY if the Attendee object loaded is not the same as the
-        // primary registration object (that way we know if we need to show create button or not)
-        if (! $this->_registration->is_primary_registrant()) {
-            $primary_registration = $this->_registration->get_primary_registration();
-            $primary_attendee     = $primary_registration instanceof EE_Registration ? $primary_registration->attendee()
-                : null;
-            if (! $primary_attendee instanceof EE_Attendee || $attendee->ID() !== $primary_attendee->ID()) {
-                // in here?  This means the displayed registration is not the primary registrant but ALREADY HAS its own
-                // custom attendee object so let's not worry about the primary reg.
-                $primary_registration = null;
-            }
-        } else {
-            $primary_registration = null;
-        }
-        $this->_template_args['ATT_ID']            = $attendee->ID();
-        $this->_template_args['fname']             = $attendee->fname();
-        $this->_template_args['lname']             = $attendee->lname();
-        $this->_template_args['email']             = $attendee->email();
-        $this->_template_args['phone']             = $attendee->phone();
-        $this->_template_args['formatted_address'] = EEH_Address::format($attendee);
-        // edit link
-        $this->_template_args['att_edit_link']  = EE_Admin_Page::add_query_args_and_nonce(
-            [
-                'action' => 'edit_attendee',
-                'post'   => $attendee->ID(),
-            ],
-            REG_ADMIN_URL
-        );
-        $this->_template_args['att_edit_title'] = esc_html__('View details for this contact.', 'event_espresso');
-        $this->_template_args['att_edit_label'] = esc_html__('View/Edit Contact', 'event_espresso');
-        // create link
-        $this->_template_args['create_link']  = $primary_registration instanceof EE_Registration
-            ? EE_Admin_Page::add_query_args_and_nonce(
-                [
-                    'action'  => 'duplicate_attendee',
-                    '_REG_ID' => $this->_registration->ID(),
-                ],
-                REG_ADMIN_URL
-            ) : '';
-        $this->_template_args['create_label'] = esc_html__('Create Contact', 'event_espresso');
-        $this->_template_args['att_check'] = $att_check;
-        $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_side_meta_box_registrant.template.php';
-        EEH_Template::display_template($template_path, $this->_template_args);
-    }
-
-
-    /**
-     * trash or restore registrations
-     *
-     * @param boolean $trash whether to archive or restore
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws RuntimeException
-     */
-    protected function _trash_or_restore_registrations($trash = true)
-    {
-        // if empty _REG_ID then get out because there's nothing to do
-        $REG_IDs = $this->request->getRequestParam('_REG_ID', [], 'int', true);
-        if (empty($REG_IDs)) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'In order to %1$s registrations you must select which ones you wish to %1$s by clicking the checkboxes.',
-                        'event_espresso'
-                    ),
-                    $trash ? 'trash' : 'restore'
-                ),
-                __FILE__,
-                __LINE__,
-                __FUNCTION__
-            );
-            $this->_redirect_after_action(false, '', '', [], true);
-        }
-        $success        = 0;
-        $overwrite_msgs = false;
-        // Checkboxes
-        $reg_count = count($REG_IDs);
-        // cycle thru checkboxes
-        foreach ($REG_IDs as $REG_ID) {
-            /** @var EE_Registration $REG */
-            $REG      = $this->getRegistrationModel()->get_one_by_ID($REG_ID);
-            $payments = $REG->registration_payments();
-            if (! empty($payments)) {
-                $name           = $REG->attendee() instanceof EE_Attendee
-                    ? $REG->attendee()->full_name()
-                    : esc_html__('Unknown Attendee', 'event_espresso');
-                $overwrite_msgs = true;
-                EE_Error::add_error(
-                    sprintf(
-                        esc_html__(
-                            'The registration for %s could not be trashed because it has payments attached to the related transaction.  If you wish to trash this registration you must first delete the payments on the related transaction.',
-                            'event_espresso'
-                        ),
-                        $name
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                // can't trash this registration because it has payments.
-                continue;
-            }
-            $updated = $trash ? $REG->delete() : $REG->restore();
-            if ($updated) {
-                $success++;
-            }
-        }
-        $this->_redirect_after_action(
-            $success === $reg_count, // were ALL registrations affected?
-            $success > 1
-                ? esc_html__('Registrations', 'event_espresso')
-                : esc_html__('Registration', 'event_espresso'),
-            $trash
-                ? esc_html__('moved to the trash', 'event_espresso')
-                : esc_html__('restored', 'event_espresso'),
-            $this->mergeExistingRequestParamsWithRedirectArgs(['action' => 'default']),
-            $overwrite_msgs
-        );
-    }
-
-
-    /**
-     * This is used to permanently delete registrations.  Note, this will handle not only deleting permanently the
-     * registration but also.
-     * 1. Removing relations to EE_Attendee
-     * 2. Deleting permanently the related transaction, but ONLY if all related registrations to the transaction are
-     * ALSO trashed.
-     * 3. Deleting permanently any related Line items but only if the above conditions are met.
-     * 4. Removing relationships between all tickets and the related registrations
-     * 5. Deleting permanently any related Answers (and the answers for other related registrations that were deleted.)
-     * 6. Deleting permanently any related Checkins.
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _delete_registrations()
-    {
-        $REG_MDL = $this->getRegistrationModel();
-        $success = 0;
-        // Checkboxes
-        $REG_IDs = $this->request->getRequestParam('_REG_ID', [], 'int', true);
-
-        if (! empty($REG_IDs)) {
-            // if array has more than one element than success message should be plural
-            $success = count($REG_IDs) > 1 ? 2 : 1;
-            // cycle thru checkboxes
-            foreach ($REG_IDs as $REG_ID) {
-                $REG = $REG_MDL->get_one_by_ID($REG_ID);
-                if (! $REG instanceof EE_Registration) {
-                    continue;
-                }
-                $deleted = $this->_delete_registration($REG);
-                if (! $deleted) {
-                    $success = 0;
-                }
-            }
-        }
-
-        $what        = $success > 1
-            ? esc_html__('Registrations', 'event_espresso')
-            : esc_html__('Registration', 'event_espresso');
-        $action_desc = esc_html__('permanently deleted.', 'event_espresso');
-        $this->_redirect_after_action(
-            $success,
-            $what,
-            $action_desc,
-            $this->mergeExistingRequestParamsWithRedirectArgs(['action' => 'default']),
-            true
-        );
-    }
-
-
-    /**
-     * handles the permanent deletion of a registration.  See comments with _delete_registrations() for details on what
-     * models get affected.
-     *
-     * @param EE_Registration $REG registration to be deleted permanently
-     * @return bool true = successful deletion, false = fail.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _delete_registration(EE_Registration $REG)
-    {
-        // first we start with the transaction... ultimately, we WILL not delete permanently if there are any related
-        // registrations on the transaction that are NOT trashed.
-        $TXN = $REG->get_first_related('Transaction');
-        if (! $TXN instanceof EE_Transaction) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'Unable to permanently delete registration %d because its related transaction has already been deleted. If you can restore the related transaction to the database then this registration can be deleted.',
-                        'event_espresso'
-                    ),
-                    $REG->id()
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        $REGS        = $TXN->get_many_related('Registration');
-        $all_trashed = true;
-        foreach ($REGS as $registration) {
-            if (! $registration->get('REG_deleted')) {
-                $all_trashed = false;
-            }
-        }
-        if (! $all_trashed) {
-            EE_Error::add_error(
-                esc_html__(
-                    'Unable to permanently delete this registration. Before this registration can be permanently deleted, all registrations made in the same transaction must be trashed as well.  These registrations will be permanently deleted in the same action.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        // k made it here so that means we can delete all the related transactions and their answers (but let's do them
-        // separately from THIS one).
-        foreach ($REGS as $registration) {
-            // delete related answers
-            $registration->delete_related_permanently('Answer');
-            // remove relationship to EE_Attendee (but we ALWAYS leave the contact record intact)
-            $attendee = $registration->get_first_related('Attendee');
-            if ($attendee instanceof EE_Attendee) {
-                $registration->_remove_relation_to($attendee, 'Attendee');
-            }
-            // now remove relationships to tickets on this registration.
-            $registration->_remove_relations('Ticket');
-            // now delete permanently the checkins related to this registration.
-            $registration->delete_related_permanently('Checkin');
-            if ($registration->ID() === $REG->ID()) {
-                continue;
-            } //we don't want to delete permanently the existing registration just yet.
-            // remove relation to transaction for these registrations if NOT the existing registrations
-            $registration->_remove_relations('Transaction');
-            // delete permanently any related messages.
-            $registration->delete_related_permanently('Message');
-            // now delete this registration permanently
-            $registration->delete_permanently();
-        }
-        // now all related registrations on the transaction are handled.  So let's just handle this registration itself
-        // (the transaction and line items should be all that's left).
-        // delete the line items related to the transaction for this registration.
-        $TXN->delete_related_permanently('Line_Item');
-        // we need to remove all the relationships on the transaction
-        $TXN->delete_related_permanently('Payment');
-        $TXN->delete_related_permanently('Extra_Meta');
-        $TXN->delete_related_permanently('Message');
-        // now we can delete this REG permanently (and the transaction of course)
-        $REG->delete_related_permanently('Transaction');
-        return $REG->delete_permanently();
-    }
-
-
-    /**
-     *    generates HTML for the Register New Attendee Admin page
-     *
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function new_registration()
-    {
-        if (! $this->_set_reg_event()) {
-            throw new EE_Error(
-                esc_html__(
-                    'Unable to continue with registering because there is no Event ID in the request',
-                    'event_espresso'
-                )
-            );
-        }
-        /** @var CurrentPage $current_page */
-        $current_page = $this->loader->getShared(CurrentPage::class);
-        $current_page->setEspressoPage(true);
-        // gotta start with a clean slate if we're not coming here via ajax
-        if (
-            ! $this->request->isAjax()
-            && (
-                ! $this->request->requestParamIsSet('processing_registration')
-                || $this->request->requestParamIsSet('step_error')
-            )
-        ) {
-            EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
-        }
-        $this->_template_args['event_name'] = '';
-        // event name
-        if ($this->_reg_event) {
-            $this->_template_args['event_name'] = $this->_reg_event->name();
-            $edit_event_url                     = self::add_query_args_and_nonce(
-                [
-                    'action' => 'edit',
-                    'post'   => $this->_reg_event->ID(),
-                ],
-                EVENTS_ADMIN_URL
-            );
-            $edit_event_lnk                     = '<a href="'
-                                                  . $edit_event_url
-                                                  . '" title="'
-                                                  . esc_attr__('Edit ', 'event_espresso')
-                                                  . $this->_reg_event->name()
-                                                  . '">'
-                                                  . esc_html__('Edit Event', 'event_espresso')
-                                                  . '</a>';
-            $this->_template_args['event_name'] .= ' <span class="admin-page-header-edit-lnk not-bold">'
-                                                   . $edit_event_lnk
-                                                   . '</span>';
-        }
-        $this->_template_args['step_content'] = $this->_get_registration_step_content();
-        if ($this->request->isAjax()) {
-            $this->_return_json();
-        }
-        // grab header
-        $template_path = REG_TEMPLATE_PATH . 'reg_admin_register_new_attendee.template.php';
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            $template_path,
-            $this->_template_args,
-            true
-        );
-        // $this->_set_publish_post_box_vars( NULL, FALSE, FALSE, NULL, FALSE );
-        // the details template wrapper
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * This returns the content for a registration step
-     *
-     * @return string html
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _get_registration_step_content()
-    {
-        if (isset($_COOKIE['ee_registration_added']) && $_COOKIE['ee_registration_added']) {
-            $warning_msg = sprintf(
-                esc_html__(
-                    '%2$sWARNING!!!%3$s%1$sPlease do not use the back button to return to this page for the purpose of adding another registration.%1$sThis can result in lost and/or corrupted data.%1$sIf you wish to add another registration, then please click the%1$s%7$s"Add Another New Registration to Event"%8$s button%1$son the Transaction details page, after you are redirected.%1$s%1$s%4$s redirecting in %5$s seconds %6$s',
-                    'event_espresso'
-                ),
-                '<br />',
-                '<h3 class="important-notice">',
-                '</h3>',
-                '<div class="float-right">',
-                '<span id="redirect_timer" class="important-notice">30</span>',
-                '</div>',
-                '<b>',
-                '</b>'
-            );
-            return '
+	}
+
+
+	/**
+	 * Updates the registration's custom questions according to the form info, if the form is submitted.
+	 * If it's not a post, the "view_registrations" route will be called next on the SAME request
+	 * to display the page
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _update_attendee_registration_form()
+	{
+		do_action('AHEE__Registrations_Admin_Page___update_attendee_registration_form__start', $this);
+		if ($_SERVER['REQUEST_METHOD'] === 'POST') {
+			$REG_ID  = $this->request->getRequestParam('_REG_ID', 0, 'int');
+			$success = $this->_save_reg_custom_questions_form($REG_ID);
+			if ($success) {
+				$what  = esc_html__('Registration Form', 'event_espresso');
+				$route = $REG_ID
+					? ['action' => 'view_registration', '_REG_ID' => $REG_ID]
+					: ['action' => 'default'];
+				$this->_redirect_after_action(true, $what, esc_html__('updated', 'event_espresso'), $route);
+			}
+		}
+	}
+
+
+	/**
+	 * Gets the form for saving registrations custom questions (if done
+	 * previously retrieves the cached form object, which may have validation errors in it)
+	 *
+	 * @param int $REG_ID
+	 * @return EE_Registration_Custom_Questions_Form
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _get_reg_custom_questions_form($REG_ID)
+	{
+		if (! $this->_reg_custom_questions_form) {
+			require_once(REG_ADMIN . 'form_sections/EE_Registration_Custom_Questions_Form.form.php');
+			$this->_reg_custom_questions_form = new EE_Registration_Custom_Questions_Form(
+				$this->getRegistrationModel()->get_one_by_ID($REG_ID)
+			);
+			$this->_reg_custom_questions_form->_construct_finalize(null, null);
+		}
+		return $this->_reg_custom_questions_form;
+	}
+
+
+	/**
+	 * Saves
+	 *
+	 * @param bool $REG_ID
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function _save_reg_custom_questions_form($REG_ID = 0)
+	{
+		if (! $REG_ID) {
+			EE_Error::add_error(
+				esc_html__(
+					'An error occurred. No registration ID was received.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		$form = $this->_get_reg_custom_questions_form($REG_ID);
+		$form->receive_form_submission($this->request->requestParams());
+		$success = false;
+		if ($form->is_valid()) {
+			foreach ($form->subforms() as $question_group_form) {
+				foreach ($question_group_form->inputs() as $question_id => $input) {
+					$where_conditions    = [
+						'QST_ID' => $question_id,
+						'REG_ID' => $REG_ID,
+					];
+					$possibly_new_values = [
+						'ANS_value' => $input->normalized_value(),
+					];
+					$answer              = EEM_Answer::instance()->get_one([$where_conditions]);
+					if ($answer instanceof EE_Answer) {
+						$success = $answer->save($possibly_new_values);
+					} else {
+						// insert it then
+						$cols_n_vals = array_merge($where_conditions, $possibly_new_values);
+						$answer      = EE_Answer::new_instance($cols_n_vals);
+						$success     = $answer->save();
+					}
+				}
+			}
+		} else {
+			EE_Error::add_error($form->get_validation_error_string(), __FILE__, __FUNCTION__, __LINE__);
+		}
+		return $success;
+	}
+
+
+	/**
+	 * generates HTML for the Registration main meta box
+	 *
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function _reg_attendees_meta_box()
+	{
+		$REG = $this->getRegistrationModel();
+		// get all other registrations on this transaction, and cache
+		// the attendees for them so we don't have to run another query using force_join
+		$registrations                           = $REG->get_all(
+			[
+				[
+					'TXN_ID' => $this->_registration->transaction_ID(),
+					'REG_ID' => ['!=', $this->_registration->ID()],
+				],
+				'force_join'               => ['Attendee'],
+				'default_where_conditions' => 'other_models_only',
+			]
+		);
+		$this->_template_args['attendees']       = [];
+		$this->_template_args['attendee_notice'] = '';
+		if (
+			empty($registrations)
+			|| (is_array($registrations)
+				&& ! EEH_Array::get_one_item_from_array($registrations))
+		) {
+			EE_Error::add_error(
+				esc_html__(
+					'There are no records attached to this registration. Something may have gone wrong with the registration',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$this->_template_args['attendee_notice'] = EE_Error::get_notices();
+		} else {
+			$att_nmbr = 1;
+			foreach ($registrations as $registration) {
+				/* @var $registration EE_Registration */
+				$attendee                                                      = $registration->attendee()
+					? $registration->attendee()
+					: $this->getAttendeeModel()->create_default_object();
+				$this->_template_args['attendees'][ $att_nmbr ]['STS_ID']      = $registration->status_ID();
+				$this->_template_args['attendees'][ $att_nmbr ]['fname']       = $attendee->fname();
+				$this->_template_args['attendees'][ $att_nmbr ]['lname']       = $attendee->lname();
+				$this->_template_args['attendees'][ $att_nmbr ]['email']       = $attendee->email();
+				$this->_template_args['attendees'][ $att_nmbr ]['final_price'] = $registration->final_price();
+				$this->_template_args['attendees'][ $att_nmbr ]['address']     = implode(
+					', ',
+					$attendee->full_address_as_array()
+				);
+				$this->_template_args['attendees'][ $att_nmbr ]['att_link']    = self::add_query_args_and_nonce(
+					[
+						'action' => 'edit_attendee',
+						'post'   => $attendee->ID(),
+					],
+					REG_ADMIN_URL
+				);
+				$this->_template_args['attendees'][ $att_nmbr ]['event_name']  =
+					$registration->event_obj() instanceof EE_Event
+						? $registration->event_obj()->name()
+						: '';
+				$att_nmbr++;
+			}
+			$this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign;
+		}
+		$template_path = REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_attendees.template.php';
+		EEH_Template::display_template($template_path, $this->_template_args);
+	}
+
+
+	/**
+	 * generates HTML for the Edit Registration side meta box
+	 *
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function _reg_registrant_side_meta_box()
+	{
+		/*@var $attendee EE_Attendee */
+		$att_check = $this->_registration->attendee();
+		$attendee  = $att_check instanceof EE_Attendee
+			? $att_check
+			: $this->getAttendeeModel()->create_default_object();
+		// now let's determine if this is not the primary registration.  If it isn't then we set the
+		// primary_registration object for reference BUT ONLY if the Attendee object loaded is not the same as the
+		// primary registration object (that way we know if we need to show create button or not)
+		if (! $this->_registration->is_primary_registrant()) {
+			$primary_registration = $this->_registration->get_primary_registration();
+			$primary_attendee     = $primary_registration instanceof EE_Registration ? $primary_registration->attendee()
+				: null;
+			if (! $primary_attendee instanceof EE_Attendee || $attendee->ID() !== $primary_attendee->ID()) {
+				// in here?  This means the displayed registration is not the primary registrant but ALREADY HAS its own
+				// custom attendee object so let's not worry about the primary reg.
+				$primary_registration = null;
+			}
+		} else {
+			$primary_registration = null;
+		}
+		$this->_template_args['ATT_ID']            = $attendee->ID();
+		$this->_template_args['fname']             = $attendee->fname();
+		$this->_template_args['lname']             = $attendee->lname();
+		$this->_template_args['email']             = $attendee->email();
+		$this->_template_args['phone']             = $attendee->phone();
+		$this->_template_args['formatted_address'] = EEH_Address::format($attendee);
+		// edit link
+		$this->_template_args['att_edit_link']  = EE_Admin_Page::add_query_args_and_nonce(
+			[
+				'action' => 'edit_attendee',
+				'post'   => $attendee->ID(),
+			],
+			REG_ADMIN_URL
+		);
+		$this->_template_args['att_edit_title'] = esc_html__('View details for this contact.', 'event_espresso');
+		$this->_template_args['att_edit_label'] = esc_html__('View/Edit Contact', 'event_espresso');
+		// create link
+		$this->_template_args['create_link']  = $primary_registration instanceof EE_Registration
+			? EE_Admin_Page::add_query_args_and_nonce(
+				[
+					'action'  => 'duplicate_attendee',
+					'_REG_ID' => $this->_registration->ID(),
+				],
+				REG_ADMIN_URL
+			) : '';
+		$this->_template_args['create_label'] = esc_html__('Create Contact', 'event_espresso');
+		$this->_template_args['att_check'] = $att_check;
+		$template_path = REG_TEMPLATE_PATH . 'reg_admin_details_side_meta_box_registrant.template.php';
+		EEH_Template::display_template($template_path, $this->_template_args);
+	}
+
+
+	/**
+	 * trash or restore registrations
+	 *
+	 * @param boolean $trash whether to archive or restore
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws RuntimeException
+	 */
+	protected function _trash_or_restore_registrations($trash = true)
+	{
+		// if empty _REG_ID then get out because there's nothing to do
+		$REG_IDs = $this->request->getRequestParam('_REG_ID', [], 'int', true);
+		if (empty($REG_IDs)) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'In order to %1$s registrations you must select which ones you wish to %1$s by clicking the checkboxes.',
+						'event_espresso'
+					),
+					$trash ? 'trash' : 'restore'
+				),
+				__FILE__,
+				__LINE__,
+				__FUNCTION__
+			);
+			$this->_redirect_after_action(false, '', '', [], true);
+		}
+		$success        = 0;
+		$overwrite_msgs = false;
+		// Checkboxes
+		$reg_count = count($REG_IDs);
+		// cycle thru checkboxes
+		foreach ($REG_IDs as $REG_ID) {
+			/** @var EE_Registration $REG */
+			$REG      = $this->getRegistrationModel()->get_one_by_ID($REG_ID);
+			$payments = $REG->registration_payments();
+			if (! empty($payments)) {
+				$name           = $REG->attendee() instanceof EE_Attendee
+					? $REG->attendee()->full_name()
+					: esc_html__('Unknown Attendee', 'event_espresso');
+				$overwrite_msgs = true;
+				EE_Error::add_error(
+					sprintf(
+						esc_html__(
+							'The registration for %s could not be trashed because it has payments attached to the related transaction.  If you wish to trash this registration you must first delete the payments on the related transaction.',
+							'event_espresso'
+						),
+						$name
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				// can't trash this registration because it has payments.
+				continue;
+			}
+			$updated = $trash ? $REG->delete() : $REG->restore();
+			if ($updated) {
+				$success++;
+			}
+		}
+		$this->_redirect_after_action(
+			$success === $reg_count, // were ALL registrations affected?
+			$success > 1
+				? esc_html__('Registrations', 'event_espresso')
+				: esc_html__('Registration', 'event_espresso'),
+			$trash
+				? esc_html__('moved to the trash', 'event_espresso')
+				: esc_html__('restored', 'event_espresso'),
+			$this->mergeExistingRequestParamsWithRedirectArgs(['action' => 'default']),
+			$overwrite_msgs
+		);
+	}
+
+
+	/**
+	 * This is used to permanently delete registrations.  Note, this will handle not only deleting permanently the
+	 * registration but also.
+	 * 1. Removing relations to EE_Attendee
+	 * 2. Deleting permanently the related transaction, but ONLY if all related registrations to the transaction are
+	 * ALSO trashed.
+	 * 3. Deleting permanently any related Line items but only if the above conditions are met.
+	 * 4. Removing relationships between all tickets and the related registrations
+	 * 5. Deleting permanently any related Answers (and the answers for other related registrations that were deleted.)
+	 * 6. Deleting permanently any related Checkins.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _delete_registrations()
+	{
+		$REG_MDL = $this->getRegistrationModel();
+		$success = 0;
+		// Checkboxes
+		$REG_IDs = $this->request->getRequestParam('_REG_ID', [], 'int', true);
+
+		if (! empty($REG_IDs)) {
+			// if array has more than one element than success message should be plural
+			$success = count($REG_IDs) > 1 ? 2 : 1;
+			// cycle thru checkboxes
+			foreach ($REG_IDs as $REG_ID) {
+				$REG = $REG_MDL->get_one_by_ID($REG_ID);
+				if (! $REG instanceof EE_Registration) {
+					continue;
+				}
+				$deleted = $this->_delete_registration($REG);
+				if (! $deleted) {
+					$success = 0;
+				}
+			}
+		}
+
+		$what        = $success > 1
+			? esc_html__('Registrations', 'event_espresso')
+			: esc_html__('Registration', 'event_espresso');
+		$action_desc = esc_html__('permanently deleted.', 'event_espresso');
+		$this->_redirect_after_action(
+			$success,
+			$what,
+			$action_desc,
+			$this->mergeExistingRequestParamsWithRedirectArgs(['action' => 'default']),
+			true
+		);
+	}
+
+
+	/**
+	 * handles the permanent deletion of a registration.  See comments with _delete_registrations() for details on what
+	 * models get affected.
+	 *
+	 * @param EE_Registration $REG registration to be deleted permanently
+	 * @return bool true = successful deletion, false = fail.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _delete_registration(EE_Registration $REG)
+	{
+		// first we start with the transaction... ultimately, we WILL not delete permanently if there are any related
+		// registrations on the transaction that are NOT trashed.
+		$TXN = $REG->get_first_related('Transaction');
+		if (! $TXN instanceof EE_Transaction) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'Unable to permanently delete registration %d because its related transaction has already been deleted. If you can restore the related transaction to the database then this registration can be deleted.',
+						'event_espresso'
+					),
+					$REG->id()
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		$REGS        = $TXN->get_many_related('Registration');
+		$all_trashed = true;
+		foreach ($REGS as $registration) {
+			if (! $registration->get('REG_deleted')) {
+				$all_trashed = false;
+			}
+		}
+		if (! $all_trashed) {
+			EE_Error::add_error(
+				esc_html__(
+					'Unable to permanently delete this registration. Before this registration can be permanently deleted, all registrations made in the same transaction must be trashed as well.  These registrations will be permanently deleted in the same action.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		// k made it here so that means we can delete all the related transactions and their answers (but let's do them
+		// separately from THIS one).
+		foreach ($REGS as $registration) {
+			// delete related answers
+			$registration->delete_related_permanently('Answer');
+			// remove relationship to EE_Attendee (but we ALWAYS leave the contact record intact)
+			$attendee = $registration->get_first_related('Attendee');
+			if ($attendee instanceof EE_Attendee) {
+				$registration->_remove_relation_to($attendee, 'Attendee');
+			}
+			// now remove relationships to tickets on this registration.
+			$registration->_remove_relations('Ticket');
+			// now delete permanently the checkins related to this registration.
+			$registration->delete_related_permanently('Checkin');
+			if ($registration->ID() === $REG->ID()) {
+				continue;
+			} //we don't want to delete permanently the existing registration just yet.
+			// remove relation to transaction for these registrations if NOT the existing registrations
+			$registration->_remove_relations('Transaction');
+			// delete permanently any related messages.
+			$registration->delete_related_permanently('Message');
+			// now delete this registration permanently
+			$registration->delete_permanently();
+		}
+		// now all related registrations on the transaction are handled.  So let's just handle this registration itself
+		// (the transaction and line items should be all that's left).
+		// delete the line items related to the transaction for this registration.
+		$TXN->delete_related_permanently('Line_Item');
+		// we need to remove all the relationships on the transaction
+		$TXN->delete_related_permanently('Payment');
+		$TXN->delete_related_permanently('Extra_Meta');
+		$TXN->delete_related_permanently('Message');
+		// now we can delete this REG permanently (and the transaction of course)
+		$REG->delete_related_permanently('Transaction');
+		return $REG->delete_permanently();
+	}
+
+
+	/**
+	 *    generates HTML for the Register New Attendee Admin page
+	 *
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function new_registration()
+	{
+		if (! $this->_set_reg_event()) {
+			throw new EE_Error(
+				esc_html__(
+					'Unable to continue with registering because there is no Event ID in the request',
+					'event_espresso'
+				)
+			);
+		}
+		/** @var CurrentPage $current_page */
+		$current_page = $this->loader->getShared(CurrentPage::class);
+		$current_page->setEspressoPage(true);
+		// gotta start with a clean slate if we're not coming here via ajax
+		if (
+			! $this->request->isAjax()
+			&& (
+				! $this->request->requestParamIsSet('processing_registration')
+				|| $this->request->requestParamIsSet('step_error')
+			)
+		) {
+			EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
+		}
+		$this->_template_args['event_name'] = '';
+		// event name
+		if ($this->_reg_event) {
+			$this->_template_args['event_name'] = $this->_reg_event->name();
+			$edit_event_url                     = self::add_query_args_and_nonce(
+				[
+					'action' => 'edit',
+					'post'   => $this->_reg_event->ID(),
+				],
+				EVENTS_ADMIN_URL
+			);
+			$edit_event_lnk                     = '<a href="'
+												  . $edit_event_url
+												  . '" title="'
+												  . esc_attr__('Edit ', 'event_espresso')
+												  . $this->_reg_event->name()
+												  . '">'
+												  . esc_html__('Edit Event', 'event_espresso')
+												  . '</a>';
+			$this->_template_args['event_name'] .= ' <span class="admin-page-header-edit-lnk not-bold">'
+												   . $edit_event_lnk
+												   . '</span>';
+		}
+		$this->_template_args['step_content'] = $this->_get_registration_step_content();
+		if ($this->request->isAjax()) {
+			$this->_return_json();
+		}
+		// grab header
+		$template_path = REG_TEMPLATE_PATH . 'reg_admin_register_new_attendee.template.php';
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			$template_path,
+			$this->_template_args,
+			true
+		);
+		// $this->_set_publish_post_box_vars( NULL, FALSE, FALSE, NULL, FALSE );
+		// the details template wrapper
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * This returns the content for a registration step
+	 *
+	 * @return string html
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _get_registration_step_content()
+	{
+		if (isset($_COOKIE['ee_registration_added']) && $_COOKIE['ee_registration_added']) {
+			$warning_msg = sprintf(
+				esc_html__(
+					'%2$sWARNING!!!%3$s%1$sPlease do not use the back button to return to this page for the purpose of adding another registration.%1$sThis can result in lost and/or corrupted data.%1$sIf you wish to add another registration, then please click the%1$s%7$s"Add Another New Registration to Event"%8$s button%1$son the Transaction details page, after you are redirected.%1$s%1$s%4$s redirecting in %5$s seconds %6$s',
+					'event_espresso'
+				),
+				'<br />',
+				'<h3 class="important-notice">',
+				'</h3>',
+				'<div class="float-right">',
+				'<span id="redirect_timer" class="important-notice">30</span>',
+				'</div>',
+				'<b>',
+				'</b>'
+			);
+			return '
 	<div id="ee-add-reg-back-button-dv"><p>' . $warning_msg . '</p></div>
 	<script >
 		// WHOAH !!! it appears that someone is using the back button from the Transaction admin page
@@ -2872,840 +2872,840 @@ 
 	        }
 	    }, 800 );
 	</script >';
-        }
-        $template_args = [
-            'title'                    => '',
-            'content'                  => '',
-            'step_button_text'         => '',
-            'show_notification_toggle' => false,
-        ];
-        // to indicate we're processing a new registration
-        $hidden_fields = [
-            'processing_registration' => [
-                'type'  => 'hidden',
-                'value' => 0,
-            ],
-            'event_id'                => [
-                'type'  => 'hidden',
-                'value' => $this->_reg_event->ID(),
-            ],
-        ];
-        // if the cart is empty then we know we're at step one, so we'll display the ticket selector
-        $cart = EE_Registry::instance()->SSN->cart();
-        $step = ! $cart instanceof EE_Cart ? 'ticket' : 'questions';
-        switch ($step) {
-            case 'ticket':
-                $hidden_fields['processing_registration']['value'] = 1;
-                $template_args['title']                            = esc_html__(
-                    'Step One: Select the Ticket for this registration',
-                    'event_espresso'
-                );
-                $template_args['content'] = EED_Ticket_Selector::instance()->display_ticket_selector($this->_reg_event);
-                $template_args['content'] .= '</div>';
-                $template_args['step_button_text'] = esc_html__(
-                    'Add Tickets and Continue to Registrant Details',
-                    'event_espresso'
-                );
-                $template_args['show_notification_toggle']         = false;
-                break;
-            case 'questions':
-                $hidden_fields['processing_registration']['value'] = 2;
-                $template_args['title']                            = esc_html__(
-                    'Step Two: Add Registrant Details for this Registration',
-                    'event_espresso'
-                );
-                // in theory, we should be able to run EED_SPCO at this point
-                // because the cart should have been set up properly by the first process_reg_step run.
-                $template_args['content'] = EED_Single_Page_Checkout::registration_checkout_for_admin();
-                $template_args['step_button_text'] = esc_html__(
-                    'Save Registration and Continue to Details',
-                    'event_espresso'
-                );
-                $template_args['show_notification_toggle'] = true;
-                break;
-        }
-        // we come back to the process_registration_step route.
-        $this->_set_add_edit_form_tags('process_reg_step', $hidden_fields);
-        return EEH_Template::display_template(
-            REG_TEMPLATE_PATH . 'reg_admin_register_new_attendee_step_content.template.php',
-            $template_args,
-            true
-        );
-    }
-
-
-    /**
-     * set_reg_event
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _set_reg_event()
-    {
-        if (is_object($this->_reg_event)) {
-            return true;
-        }
-
-        $EVT_ID = $this->request->getRequestParam('event_id', 0, 'int');
-        if (! $EVT_ID) {
-            return false;
-        }
-        $this->_reg_event = $this->getEventModel()->get_one_by_ID($EVT_ID);
-        return true;
-    }
-
-
-    /**
-     * process_reg_step
-     *
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    public function process_reg_step()
-    {
-        EE_System::do_not_cache();
-        $this->_set_reg_event();
-        /** @var CurrentPage $current_page */
-        $current_page = $this->loader->getShared(CurrentPage::class);
-        $current_page->setEspressoPage(true);
-        $this->request->setRequestParam('uts', time());
-        // what step are we on?
-        $cart = EE_Registry::instance()->SSN->cart();
-        $step = ! $cart instanceof EE_Cart ? 'ticket' : 'questions';
-        // if doing ajax then we need to verify the nonce
-        if ($this->request->isAjax()) {
-            $nonce = $this->request->getRequestParam($this->_req_nonce, '');
-            $this->_verify_nonce($nonce, $this->_req_nonce);
-        }
-        switch ($step) {
-            case 'ticket':
-                // process ticket selection
-                $success = EED_Ticket_Selector::instance()->process_ticket_selections();
-                if ($success) {
-                    EE_Error::add_success(
-                        esc_html__(
-                            'Tickets Selected. Now complete the registration.',
-                            'event_espresso'
-                        )
-                    );
-                } else {
-                    $this->request->setRequestParam('step_error', true);
-                    $query_args['step_error'] = $this->request->getRequestParam('step_error', true, 'bool');
-                }
-                if ($this->request->isAjax()) {
-                    $this->new_registration(); // display next step
-                } else {
-                    $query_args = [
-                        'action'                  => 'new_registration',
-                        'processing_registration' => 1,
-                        'event_id'                => $this->_reg_event->ID(),
-                        'uts'                     => time(),
-                    ];
-                    $this->_redirect_after_action(
-                        false,
-                        '',
-                        '',
-                        $query_args,
-                        true
-                    );
-                }
-                break;
-            case 'questions':
-                if (! $this->request->requestParamIsSet('txn_reg_status_change[send_notifications]')) {
-                    add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_false', 15);
-                }
-                // process registration
-                $transaction = EED_Single_Page_Checkout::instance()->process_registration_from_admin();
-                if ($cart instanceof EE_Cart) {
-                    $grand_total = $cart->get_grand_total();
-                    if ($grand_total instanceof EE_Line_Item) {
-                        $grand_total->save_this_and_descendants_to_txn();
-                    }
-                }
-                if (! $transaction instanceof EE_Transaction) {
-                    $query_args = [
-                        'action'                  => 'new_registration',
-                        'processing_registration' => 2,
-                        'event_id'                => $this->_reg_event->ID(),
-                        'uts'                     => time(),
-                    ];
-                    if ($this->request->isAjax()) {
-                        // display registration form again because there are errors (maybe validation?)
-                        $this->new_registration();
-                        return;
-                    }
-                    $this->_redirect_after_action(
-                        false,
-                        '',
-                        '',
-                        $query_args,
-                        true
-                    );
-                    return;
-                }
-                // maybe update status, and make sure to save transaction if not done already
-                if (! $transaction->update_status_based_on_total_paid()) {
-                    $transaction->save();
-                }
-                EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
-                $query_args = [
-                    'action'        => 'redirect_to_txn',
-                    'TXN_ID'        => $transaction->ID(),
-                    'EVT_ID'        => $this->_reg_event->ID(),
-                    'event_name'    => urlencode($this->_reg_event->name()),
-                    'redirect_from' => 'new_registration',
-                ];
-                $this->_redirect_after_action(false, '', '', $query_args, true);
-                break;
-        }
-        // what are you looking here for?  Should be nothing to do at this point.
-    }
-
-
-    /**
-     * redirect_to_txn
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function redirect_to_txn()
-    {
-        EE_System::do_not_cache();
-        EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
-        $query_args = [
-            'action' => 'view_transaction',
-            'TXN_ID' => $this->request->getRequestParam('TXN_ID', 0, 'int'),
-            'page'   => 'espresso_transactions',
-        ];
-        if ($this->request->requestParamIsSet('EVT_ID') && $this->request->requestParamIsSet('redirect_from')) {
-            $query_args['EVT_ID']        = $this->request->getRequestParam('EVT_ID', 0, 'int');
-            $query_args['event_name']    = urlencode($this->request->getRequestParam('event_name'));
-            $query_args['redirect_from'] = $this->request->getRequestParam('redirect_from');
-        }
-        EE_Error::add_success(
-            esc_html__(
-                'Registration Created.  Please review the transaction and add any payments as necessary',
-                'event_espresso'
-            )
-        );
-        $this->_redirect_after_action(false, '', '', $query_args, true);
-    }
-
-
-    /**
-     * generates HTML for the Attendee Contact List
-     *
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    protected function _attendee_contact_list_table()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $this->_search_btn_label = esc_html__('Contacts', 'event_espresso');
-        $this->display_admin_list_table_page_with_no_sidebar();
-    }
-
-
-    /**
-     * get_attendees
-     *
-     * @param      $per_page
-     * @param bool $count whether to return count or data.
-     * @param bool $trash
-     * @return array|int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_attendees($per_page, $count = false, $trash = false)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        require_once(REG_ADMIN . 'EE_Attendee_Contact_List_Table.class.php');
-        $orderby = $this->request->getRequestParam('orderby');
-        switch ($orderby) {
-            case 'ATT_ID':
-            case 'ATT_fname':
-            case 'ATT_email':
-            case 'ATT_city':
-            case 'STA_ID':
-            case 'CNT_ID':
-                break;
-            case 'Registration_Count':
-                $orderby = 'Registration_Count';
-                break;
-            default:
-                $orderby = 'ATT_lname';
-        }
-        $sort         = $this->request->getRequestParam('order', 'ASC');
-        $current_page = $this->request->getRequestParam('paged', 1, 'int');
-        $per_page     = absint($per_page) ? $per_page : 10;
-        $per_page     = $this->request->getRequestParam('perpage', $per_page, 'int');
-        $_where       = [];
-        $search_term  = $this->request->getRequestParam('s');
-        if ($search_term) {
-            $search_term  = '%' . $search_term . '%';
-            $_where['OR'] = [
-                'Registration.Event.EVT_name'       => ['LIKE', $search_term],
-                'Registration.Event.EVT_desc'       => ['LIKE', $search_term],
-                'Registration.Event.EVT_short_desc' => ['LIKE', $search_term],
-                'ATT_fname'                         => ['LIKE', $search_term],
-                'ATT_lname'                         => ['LIKE', $search_term],
-                'ATT_short_bio'                     => ['LIKE', $search_term],
-                'ATT_email'                         => ['LIKE', $search_term],
-                'ATT_address'                       => ['LIKE', $search_term],
-                'ATT_address2'                      => ['LIKE', $search_term],
-                'ATT_city'                          => ['LIKE', $search_term],
-                'Country.CNT_name'                  => ['LIKE', $search_term],
-                'State.STA_name'                    => ['LIKE', $search_term],
-                'ATT_phone'                         => ['LIKE', $search_term],
-                'Registration.REG_final_price'      => ['LIKE', $search_term],
-                'Registration.REG_code'             => ['LIKE', $search_term],
-                'Registration.REG_group_size'       => ['LIKE', $search_term],
-            ];
-        }
-        $offset     = ($current_page - 1) * $per_page;
-        $limit      = $count ? null : [$offset, $per_page];
-        $query_args = [
-            $_where,
-            'extra_selects' => ['Registration_Count' => ['Registration.REG_ID', 'count', '%d']],
-            'limit'         => $limit,
-        ];
-        if (! $count) {
-            $query_args['order_by'] = [$orderby => $sort];
-        }
-        $query_args[0]['status'] = $trash ? ['!=', 'publish'] : ['IN', ['publish']];
-        return $count
-            ? $this->getAttendeeModel()->count($query_args, 'ATT_ID', true)
-            : $this->getAttendeeModel()->get_all($query_args);
-    }
-
-
-    /**
-     * This is just taking care of resending the registration confirmation
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _resend_registration()
-    {
-        $this->_process_resend_registration();
-        $REG_ID      = $this->request->getRequestParam('_REG_ID', 0, 'int');
-        $redirect_to = $this->request->getRequestParam('redirect_to');
-        $query_args  = $redirect_to
-            ? ['action' => $redirect_to, '_REG_ID' => $REG_ID]
-            : ['action' => 'default'];
-        $this->_redirect_after_action(false, '', '', $query_args, true);
-    }
-
-
-    /**
-     * Creates a registration report, but accepts the name of a method to use for preparing the query parameters
-     * to use when selecting registrations
-     *
-     * @param string $method_name_for_getting_query_params the name of the method (on this class) to use for preparing
-     *                                                     the query parameters from the request
-     * @return void ends the request with a redirect or download
-     */
-    public function _registrations_report_base($method_name_for_getting_query_params)
-    {
-        $EVT_ID = $this->request->requestParamIsSet('EVT_ID')
-            ? $this->request->getRequestParam('EVT_ID', 0, DataType::INT)
-            : null;
-        if (! defined('EE_USE_OLD_CSV_REPORT_CLASS')) {
-            $return_url = $this->request->getRequestParam('return_url', '', DataType::URL);
-            $filters = $this->request->getRequestParam('filters', [], DataType::STRING, true);
-            $use_filters = $this->request->getRequestParam('use_filters', false, DataType::BOOL);
-            wp_redirect(
-                EE_Admin_Page::add_query_args_and_nonce(
-                    [
-                        'page'        => EED_Batch::PAGE_SLUG,
-                        'batch'       => EED_Batch::batch_file_job,
-                        'EVT_ID'      => $EVT_ID,
-                        'filters'     => urlencode(serialize($this->$method_name_for_getting_query_params($filters))),
-                        'use_filters' => urlencode($use_filters),
-                        'job_handler' => urlencode('EventEspressoBatchRequest\JobHandlers\RegistrationsReport'),
-                        'return_url'  => urlencode($return_url),
-                    ]
-                )
-            );
-        } else {
-            // Pull the current request params
-            $request_args = $this->request->requestParams();
-            // Set the required request_args to be passed to the export
-            $required_request_args = [
-                'export' => 'report',
-                'action' => 'registrations_report_for_event',
-                'EVT_ID' => $EVT_ID,
-            ];
-            // Merge required request args, overriding any currently set
-            $request_args = array_merge($request_args, $required_request_args);
-            if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
-                require_once(EE_CLASSES . 'EE_Export.class.php');
-                $EE_Export = EE_Export::instance($request_args);
-                $EE_Export->export();
-            }
-        }
-    }
-
-
-    /**
-     * Creates a registration report using only query parameters in the request
-     *
-     * @return void
-     */
-    public function _registrations_report()
-    {
-        $this->_registrations_report_base('_get_registration_query_parameters');
-    }
-
-
-    public function _contact_list_export()
-    {
-        if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
-            require_once(EE_CLASSES . 'EE_Export.class.php');
-            $EE_Export = EE_Export::instance($this->request->requestParams());
-            $EE_Export->export_attendees();
-        }
-    }
-
-
-    public function _contact_list_report()
-    {
-        if (! defined('EE_USE_OLD_CSV_REPORT_CLASS')) {
-            wp_redirect(
-                EE_Admin_Page::add_query_args_and_nonce(
-                    [
-                        'page'        => EED_Batch::PAGE_SLUG,
-                        'batch'       => EED_Batch::batch_file_job,
-                        'job_handler' => urlencode('EventEspressoBatchRequest\JobHandlers\AttendeesReport'),
-                        'return_url'  => urlencode($this->request->getRequestParam('return_url', '', DataType::URL)),
-                    ]
-                )
-            );
-        } else {
-            if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
-                require_once(EE_CLASSES . 'EE_Export.class.php');
-                $EE_Export = EE_Export::instance($this->request->requestParams());
-                $EE_Export->report_attendees();
-            }
-        }
-    }
-
-
-
-
-
-    /***************************************        ATTENDEE DETAILS        ***************************************/
-    /**
-     * This duplicates the attendee object for the given incoming registration id and attendee_id.
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _duplicate_attendee()
-    {
-        $REG_ID = $this->request->getRequestParam('_REG_ID', 0, 'int');
-        $action = $this->request->getRequestParam('return', 'default');
-        // verify we have necessary info
-        if (! $REG_ID) {
-            EE_Error::add_error(
-                esc_html__(
-                    'Unable to create the contact for the registration because the required parameters are not present (_REG_ID )',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __LINE__,
-                __FUNCTION__
-            );
-            $query_args = ['action' => $action];
-            $this->_redirect_after_action('', '', '', $query_args, true);
-        }
-        // okay necessary deets present... let's dupe the incoming attendee and attach to incoming registration.
-        $registration = $this->getRegistrationModel()->get_one_by_ID($REG_ID);
-        if (! $registration instanceof EE_Registration) {
-            throw new RuntimeException(
-                sprintf(
-                    esc_html__(
-                        'Unable to create the contact because a valid registration could not be retrieved for REG ID: %1$d',
-                        'event_espresso'
-                    ),
-                    $REG_ID
-                )
-            );
-        }
-        $attendee = $registration->attendee();
-        // remove relation of existing attendee on registration
-        $registration->_remove_relation_to($attendee, 'Attendee');
-        // new attendee
-        $new_attendee = clone $attendee;
-        $new_attendee->set('ATT_ID', 0);
-        $new_attendee->save();
-        // add new attendee to reg
-        $registration->_add_relation_to($new_attendee, 'Attendee');
-        EE_Error::add_success(
-            esc_html__(
-                'New Contact record created.  Now make any edits you wish to make for this contact.',
-                'event_espresso'
-            )
-        );
-        // redirect to edit page for attendee
-        $query_args = ['post' => $new_attendee->ID(), 'action' => 'edit_attendee'];
-        $this->_redirect_after_action('', '', '', $query_args, true);
-    }
-
-
-    /**
-     * Callback invoked by parent EE_Admin_CPT class hooked in on `save_post` wp hook.
-     *
-     * @param int     $post_id
-     * @param WP_Post $post
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws LogicException
-     * @throws InvalidFormSubmissionException
-     * @throws ReflectionException
-     */
-    protected function _insert_update_cpt_item($post_id, $post)
-    {
-        $success  = true;
-        $attendee = $post instanceof WP_Post && $post->post_type === 'espresso_attendees'
-            ? $this->getAttendeeModel()->get_one_by_ID($post_id)
-            : null;
-        // for attendee updates
-        if ($attendee instanceof EE_Attendee) {
-            // note we should only be UPDATING attendees at this point.
-            $fname          = $this->request->getRequestParam('ATT_fname', '');
-            $lname          = $this->request->getRequestParam('ATT_lname', '');
-            $updated_fields = [
-                'ATT_fname'     => $fname,
-                'ATT_lname'     => $lname,
-                'ATT_full_name' => "{$fname} {$lname}",
-                'ATT_address'   => $this->request->getRequestParam('ATT_address', ''),
-                'ATT_address2'  => $this->request->getRequestParam('ATT_address2', ''),
-                'ATT_city'      => $this->request->getRequestParam('ATT_city', ''),
-                'STA_ID'        => $this->request->getRequestParam('STA_ID', ''),
-                'CNT_ISO'       => $this->request->getRequestParam('CNT_ISO', ''),
-                'ATT_zip'       => $this->request->getRequestParam('ATT_zip', ''),
-            ];
-            foreach ($updated_fields as $field => $value) {
-                $attendee->set($field, $value);
-            }
-
-            // process contact details metabox form handler (which will also save the attendee)
-            $contact_details_form = $this->getAttendeeContactDetailsMetaboxFormHandler($attendee);
-            $success              = $contact_details_form->process($this->request->requestParams());
-
-            $attendee_update_callbacks = apply_filters(
-                'FHEE__Registrations_Admin_Page__insert_update_cpt_item__attendee_update',
-                []
-            );
-            foreach ($attendee_update_callbacks as $a_callback) {
-                if (false === call_user_func_array($a_callback, [$attendee, $this->request->requestParams()])) {
-                    throw new EE_Error(
-                        sprintf(
-                            esc_html__(
-                                'The %s callback given for the "FHEE__Registrations_Admin_Page__insert_update_cpt_item__attendee_update" filter is not a valid callback.  Please check the spelling.',
-                                'event_espresso'
-                            ),
-                            $a_callback
-                        )
-                    );
-                }
-            }
-        }
-
-        if ($success === false) {
-            EE_Error::add_error(
-                esc_html__(
-                    'Something went wrong with updating the meta table data for the registration.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-    }
-
-
-    public function trash_cpt_item($post_id)
-    {
-    }
-
-
-    public function delete_cpt_item($post_id)
-    {
-    }
-
-
-    public function restore_cpt_item($post_id)
-    {
-    }
-
-
-    protected function _restore_cpt_item($post_id, $revision_id)
-    {
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since 4.10.2.p
-     */
-    public function attendee_editor_metaboxes()
-    {
-        $this->verify_cpt_object();
-        remove_meta_box(
-            'postexcerpt',
-            $this->_cpt_routes[ $this->_req_action ],
-            'normal'
-        );
-        remove_meta_box('commentstatusdiv', $this->_cpt_routes[ $this->_req_action ], 'normal');
-        if (post_type_supports('espresso_attendees', 'excerpt')) {
-            $this->addMetaBox(
-                'postexcerpt',
-                esc_html__('Short Biography', 'event_espresso'),
-                'post_excerpt_meta_box',
-                $this->_cpt_routes[ $this->_req_action ]
-            );
-        }
-        if (post_type_supports('espresso_attendees', 'comments')) {
-            $this->addMetaBox(
-                'commentsdiv',
-                esc_html__('Notes on the Contact', 'event_espresso'),
-                'post_comment_meta_box',
-                $this->_cpt_routes[ $this->_req_action ],
-                'normal',
-                'core'
-            );
-        }
-        $this->addMetaBox(
-            'attendee_contact_info',
-            esc_html__('Contact Info', 'event_espresso'),
-            [$this, 'attendee_contact_info'],
-            $this->_cpt_routes[ $this->_req_action ],
-            'side',
-            'core'
-        );
-        $this->addMetaBox(
-            'attendee_details_address',
-            esc_html__('Address Details', 'event_espresso'),
-            [$this, 'attendee_address_details'],
-            $this->_cpt_routes[ $this->_req_action ],
-            'normal',
-            'core'
-        );
-        $this->addMetaBox(
-            'attendee_registrations',
-            esc_html__('Registrations for this Contact', 'event_espresso'),
-            [$this, 'attendee_registrations_meta_box'],
-            $this->_cpt_routes[ $this->_req_action ]
-        );
-    }
-
-
-    /**
-     * Metabox for attendee contact info
-     *
-     * @param WP_Post $post wp post object
-     * @return void attendee contact info ( and form )
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws LogicException
-     * @throws DomainException
-     */
-    public function attendee_contact_info($post)
-    {
-        // get attendee object ( should already have it )
-        $form = $this->getAttendeeContactDetailsMetaboxFormHandler($this->_cpt_model_obj);
-        $form->enqueueStylesAndScripts();
-        echo wp_kses($form->display(), AllowedTags::getWithFormTags());
-    }
-
-
-    /**
-     * Return form handler for the contact details metabox
-     *
-     * @param EE_Attendee $attendee
-     * @return AttendeeContactDetailsMetaboxFormHandler
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function getAttendeeContactDetailsMetaboxFormHandler(EE_Attendee $attendee)
-    {
-        return new AttendeeContactDetailsMetaboxFormHandler($attendee, EE_Registry::instance());
-    }
-
-
-    /**
-     * Metabox for attendee details
-     *
-     * @param WP_Post $post wp post object
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function attendee_address_details($post)
-    {
-        // get attendee object (should already have it)
-        $this->_template_args['attendee']     = $this->_cpt_model_obj;
-        $this->_template_args['state_html']   = EEH_Form_Fields::generate_form_input(
-            new EE_Question_Form_Input(
-                EE_Question::new_instance(
-                    [
-                        'QST_ID'           => 0,
-                        'QST_display_text' => esc_html__('State/Province', 'event_espresso'),
-                        'QST_system'       => 'admin-state',
-                    ]
-                ),
-                EE_Answer::new_instance(
-                    [
-                        'ANS_ID'    => 0,
-                        'ANS_value' => $this->_cpt_model_obj->state_ID(),
-                    ]
-                ),
-                [
-                    'input_id'       => 'STA_ID',
-                    'input_name'     => 'STA_ID',
-                    'input_prefix'   => '',
-                    'append_qstn_id' => false,
-                ]
-            )
-        );
-        $this->_template_args['country_html'] = EEH_Form_Fields::generate_form_input(
-            new EE_Question_Form_Input(
-                EE_Question::new_instance(
-                    [
-                        'QST_ID'           => 0,
-                        'QST_display_text' => esc_html__('Country', 'event_espresso'),
-                        'QST_system'       => 'admin-country',
-                    ]
-                ),
-                EE_Answer::new_instance(
-                    [
-                        'ANS_ID'    => 0,
-                        'ANS_value' => $this->_cpt_model_obj->country_ID(),
-                    ]
-                ),
-                [
-                    'input_id'       => 'CNT_ISO',
-                    'input_name'     => 'CNT_ISO',
-                    'input_prefix'   => '',
-                    'append_qstn_id' => false,
-                ]
-            )
-        );
-        $template = REG_TEMPLATE_PATH . 'attendee_address_details_metabox_content.template.php';
-        EEH_Template::display_template($template, $this->_template_args);
-    }
-
-
-    /**
-     * _attendee_details
-     *
-     * @param $post
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function attendee_registrations_meta_box($post)
-    {
-        $this->_template_args['attendee']      = $this->_cpt_model_obj;
-        $this->_template_args['registrations'] = $this->_cpt_model_obj->get_many_related('Registration');
-        $template = REG_TEMPLATE_PATH . 'attendee_registrations_main_meta_box.template.php';
-        EEH_Template::display_template($template, $this->_template_args);
-    }
-
-
-    /**
-     * add in the form fields for the attendee edit
-     *
-     * @param WP_Post $post wp post object
-     * @return void echos html for new form.
-     * @throws DomainException
-     */
-    public function after_title_form_fields($post)
-    {
-        if ($post->post_type === 'espresso_attendees') {
-            $template                  = REG_TEMPLATE_PATH . 'attendee_details_after_title_form_fields.template.php';
-            $template_args['attendee'] = $this->_cpt_model_obj;
-            EEH_Template::display_template($template, $template_args);
-        }
-    }
-
-
-    /**
-     * _trash_or_restore_attendee
-     *
-     * @param boolean $trash - whether to move item to trash (TRUE) or restore it (FALSE)
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _trash_or_restore_attendees($trash = true)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $status = $trash ? 'trash' : 'publish';
-        // Checkboxes
-        if ($this->request->requestParamIsSet('checkbox')) {
-            $ATT_IDs = $this->request->getRequestParam('checkbox', [], 'int', true);
-            // if array has more than one element than success message should be plural
-            $success = count($ATT_IDs) > 1 ? 2 : 1;
-            // cycle thru checkboxes
-            foreach ($ATT_IDs as $ATT_ID) {
-                $updated = $this->getAttendeeModel()->update_by_ID(['status' => $status], $ATT_ID);
-                if (! $updated) {
-                    $success = 0;
-                }
-            }
-        } else {
-            // grab single id and delete
-            $ATT_ID = $this->request->getRequestParam('ATT_ID', 0, 'int');
-            // update attendee
-            $success = $this->getAttendeeModel()->update_by_ID(['status' => $status], $ATT_ID) ? 1 : 0;
-        }
-        $what        = $success > 1
-            ? esc_html__('Contacts', 'event_espresso')
-            : esc_html__('Contact', 'event_espresso');
-        $action_desc = $trash
-            ? esc_html__('moved to the trash', 'event_espresso')
-            : esc_html__('restored', 'event_espresso');
-        $this->_redirect_after_action($success, $what, $action_desc, ['action' => 'contact_list']);
-    }
+		}
+		$template_args = [
+			'title'                    => '',
+			'content'                  => '',
+			'step_button_text'         => '',
+			'show_notification_toggle' => false,
+		];
+		// to indicate we're processing a new registration
+		$hidden_fields = [
+			'processing_registration' => [
+				'type'  => 'hidden',
+				'value' => 0,
+			],
+			'event_id'                => [
+				'type'  => 'hidden',
+				'value' => $this->_reg_event->ID(),
+			],
+		];
+		// if the cart is empty then we know we're at step one, so we'll display the ticket selector
+		$cart = EE_Registry::instance()->SSN->cart();
+		$step = ! $cart instanceof EE_Cart ? 'ticket' : 'questions';
+		switch ($step) {
+			case 'ticket':
+				$hidden_fields['processing_registration']['value'] = 1;
+				$template_args['title']                            = esc_html__(
+					'Step One: Select the Ticket for this registration',
+					'event_espresso'
+				);
+				$template_args['content'] = EED_Ticket_Selector::instance()->display_ticket_selector($this->_reg_event);
+				$template_args['content'] .= '</div>';
+				$template_args['step_button_text'] = esc_html__(
+					'Add Tickets and Continue to Registrant Details',
+					'event_espresso'
+				);
+				$template_args['show_notification_toggle']         = false;
+				break;
+			case 'questions':
+				$hidden_fields['processing_registration']['value'] = 2;
+				$template_args['title']                            = esc_html__(
+					'Step Two: Add Registrant Details for this Registration',
+					'event_espresso'
+				);
+				// in theory, we should be able to run EED_SPCO at this point
+				// because the cart should have been set up properly by the first process_reg_step run.
+				$template_args['content'] = EED_Single_Page_Checkout::registration_checkout_for_admin();
+				$template_args['step_button_text'] = esc_html__(
+					'Save Registration and Continue to Details',
+					'event_espresso'
+				);
+				$template_args['show_notification_toggle'] = true;
+				break;
+		}
+		// we come back to the process_registration_step route.
+		$this->_set_add_edit_form_tags('process_reg_step', $hidden_fields);
+		return EEH_Template::display_template(
+			REG_TEMPLATE_PATH . 'reg_admin_register_new_attendee_step_content.template.php',
+			$template_args,
+			true
+		);
+	}
+
+
+	/**
+	 * set_reg_event
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _set_reg_event()
+	{
+		if (is_object($this->_reg_event)) {
+			return true;
+		}
+
+		$EVT_ID = $this->request->getRequestParam('event_id', 0, 'int');
+		if (! $EVT_ID) {
+			return false;
+		}
+		$this->_reg_event = $this->getEventModel()->get_one_by_ID($EVT_ID);
+		return true;
+	}
+
+
+	/**
+	 * process_reg_step
+	 *
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	public function process_reg_step()
+	{
+		EE_System::do_not_cache();
+		$this->_set_reg_event();
+		/** @var CurrentPage $current_page */
+		$current_page = $this->loader->getShared(CurrentPage::class);
+		$current_page->setEspressoPage(true);
+		$this->request->setRequestParam('uts', time());
+		// what step are we on?
+		$cart = EE_Registry::instance()->SSN->cart();
+		$step = ! $cart instanceof EE_Cart ? 'ticket' : 'questions';
+		// if doing ajax then we need to verify the nonce
+		if ($this->request->isAjax()) {
+			$nonce = $this->request->getRequestParam($this->_req_nonce, '');
+			$this->_verify_nonce($nonce, $this->_req_nonce);
+		}
+		switch ($step) {
+			case 'ticket':
+				// process ticket selection
+				$success = EED_Ticket_Selector::instance()->process_ticket_selections();
+				if ($success) {
+					EE_Error::add_success(
+						esc_html__(
+							'Tickets Selected. Now complete the registration.',
+							'event_espresso'
+						)
+					);
+				} else {
+					$this->request->setRequestParam('step_error', true);
+					$query_args['step_error'] = $this->request->getRequestParam('step_error', true, 'bool');
+				}
+				if ($this->request->isAjax()) {
+					$this->new_registration(); // display next step
+				} else {
+					$query_args = [
+						'action'                  => 'new_registration',
+						'processing_registration' => 1,
+						'event_id'                => $this->_reg_event->ID(),
+						'uts'                     => time(),
+					];
+					$this->_redirect_after_action(
+						false,
+						'',
+						'',
+						$query_args,
+						true
+					);
+				}
+				break;
+			case 'questions':
+				if (! $this->request->requestParamIsSet('txn_reg_status_change[send_notifications]')) {
+					add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_false', 15);
+				}
+				// process registration
+				$transaction = EED_Single_Page_Checkout::instance()->process_registration_from_admin();
+				if ($cart instanceof EE_Cart) {
+					$grand_total = $cart->get_grand_total();
+					if ($grand_total instanceof EE_Line_Item) {
+						$grand_total->save_this_and_descendants_to_txn();
+					}
+				}
+				if (! $transaction instanceof EE_Transaction) {
+					$query_args = [
+						'action'                  => 'new_registration',
+						'processing_registration' => 2,
+						'event_id'                => $this->_reg_event->ID(),
+						'uts'                     => time(),
+					];
+					if ($this->request->isAjax()) {
+						// display registration form again because there are errors (maybe validation?)
+						$this->new_registration();
+						return;
+					}
+					$this->_redirect_after_action(
+						false,
+						'',
+						'',
+						$query_args,
+						true
+					);
+					return;
+				}
+				// maybe update status, and make sure to save transaction if not done already
+				if (! $transaction->update_status_based_on_total_paid()) {
+					$transaction->save();
+				}
+				EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
+				$query_args = [
+					'action'        => 'redirect_to_txn',
+					'TXN_ID'        => $transaction->ID(),
+					'EVT_ID'        => $this->_reg_event->ID(),
+					'event_name'    => urlencode($this->_reg_event->name()),
+					'redirect_from' => 'new_registration',
+				];
+				$this->_redirect_after_action(false, '', '', $query_args, true);
+				break;
+		}
+		// what are you looking here for?  Should be nothing to do at this point.
+	}
+
+
+	/**
+	 * redirect_to_txn
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function redirect_to_txn()
+	{
+		EE_System::do_not_cache();
+		EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
+		$query_args = [
+			'action' => 'view_transaction',
+			'TXN_ID' => $this->request->getRequestParam('TXN_ID', 0, 'int'),
+			'page'   => 'espresso_transactions',
+		];
+		if ($this->request->requestParamIsSet('EVT_ID') && $this->request->requestParamIsSet('redirect_from')) {
+			$query_args['EVT_ID']        = $this->request->getRequestParam('EVT_ID', 0, 'int');
+			$query_args['event_name']    = urlencode($this->request->getRequestParam('event_name'));
+			$query_args['redirect_from'] = $this->request->getRequestParam('redirect_from');
+		}
+		EE_Error::add_success(
+			esc_html__(
+				'Registration Created.  Please review the transaction and add any payments as necessary',
+				'event_espresso'
+			)
+		);
+		$this->_redirect_after_action(false, '', '', $query_args, true);
+	}
+
+
+	/**
+	 * generates HTML for the Attendee Contact List
+	 *
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	protected function _attendee_contact_list_table()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$this->_search_btn_label = esc_html__('Contacts', 'event_espresso');
+		$this->display_admin_list_table_page_with_no_sidebar();
+	}
+
+
+	/**
+	 * get_attendees
+	 *
+	 * @param      $per_page
+	 * @param bool $count whether to return count or data.
+	 * @param bool $trash
+	 * @return array|int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_attendees($per_page, $count = false, $trash = false)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		require_once(REG_ADMIN . 'EE_Attendee_Contact_List_Table.class.php');
+		$orderby = $this->request->getRequestParam('orderby');
+		switch ($orderby) {
+			case 'ATT_ID':
+			case 'ATT_fname':
+			case 'ATT_email':
+			case 'ATT_city':
+			case 'STA_ID':
+			case 'CNT_ID':
+				break;
+			case 'Registration_Count':
+				$orderby = 'Registration_Count';
+				break;
+			default:
+				$orderby = 'ATT_lname';
+		}
+		$sort         = $this->request->getRequestParam('order', 'ASC');
+		$current_page = $this->request->getRequestParam('paged', 1, 'int');
+		$per_page     = absint($per_page) ? $per_page : 10;
+		$per_page     = $this->request->getRequestParam('perpage', $per_page, 'int');
+		$_where       = [];
+		$search_term  = $this->request->getRequestParam('s');
+		if ($search_term) {
+			$search_term  = '%' . $search_term . '%';
+			$_where['OR'] = [
+				'Registration.Event.EVT_name'       => ['LIKE', $search_term],
+				'Registration.Event.EVT_desc'       => ['LIKE', $search_term],
+				'Registration.Event.EVT_short_desc' => ['LIKE', $search_term],
+				'ATT_fname'                         => ['LIKE', $search_term],
+				'ATT_lname'                         => ['LIKE', $search_term],
+				'ATT_short_bio'                     => ['LIKE', $search_term],
+				'ATT_email'                         => ['LIKE', $search_term],
+				'ATT_address'                       => ['LIKE', $search_term],
+				'ATT_address2'                      => ['LIKE', $search_term],
+				'ATT_city'                          => ['LIKE', $search_term],
+				'Country.CNT_name'                  => ['LIKE', $search_term],
+				'State.STA_name'                    => ['LIKE', $search_term],
+				'ATT_phone'                         => ['LIKE', $search_term],
+				'Registration.REG_final_price'      => ['LIKE', $search_term],
+				'Registration.REG_code'             => ['LIKE', $search_term],
+				'Registration.REG_group_size'       => ['LIKE', $search_term],
+			];
+		}
+		$offset     = ($current_page - 1) * $per_page;
+		$limit      = $count ? null : [$offset, $per_page];
+		$query_args = [
+			$_where,
+			'extra_selects' => ['Registration_Count' => ['Registration.REG_ID', 'count', '%d']],
+			'limit'         => $limit,
+		];
+		if (! $count) {
+			$query_args['order_by'] = [$orderby => $sort];
+		}
+		$query_args[0]['status'] = $trash ? ['!=', 'publish'] : ['IN', ['publish']];
+		return $count
+			? $this->getAttendeeModel()->count($query_args, 'ATT_ID', true)
+			: $this->getAttendeeModel()->get_all($query_args);
+	}
+
+
+	/**
+	 * This is just taking care of resending the registration confirmation
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _resend_registration()
+	{
+		$this->_process_resend_registration();
+		$REG_ID      = $this->request->getRequestParam('_REG_ID', 0, 'int');
+		$redirect_to = $this->request->getRequestParam('redirect_to');
+		$query_args  = $redirect_to
+			? ['action' => $redirect_to, '_REG_ID' => $REG_ID]
+			: ['action' => 'default'];
+		$this->_redirect_after_action(false, '', '', $query_args, true);
+	}
+
+
+	/**
+	 * Creates a registration report, but accepts the name of a method to use for preparing the query parameters
+	 * to use when selecting registrations
+	 *
+	 * @param string $method_name_for_getting_query_params the name of the method (on this class) to use for preparing
+	 *                                                     the query parameters from the request
+	 * @return void ends the request with a redirect or download
+	 */
+	public function _registrations_report_base($method_name_for_getting_query_params)
+	{
+		$EVT_ID = $this->request->requestParamIsSet('EVT_ID')
+			? $this->request->getRequestParam('EVT_ID', 0, DataType::INT)
+			: null;
+		if (! defined('EE_USE_OLD_CSV_REPORT_CLASS')) {
+			$return_url = $this->request->getRequestParam('return_url', '', DataType::URL);
+			$filters = $this->request->getRequestParam('filters', [], DataType::STRING, true);
+			$use_filters = $this->request->getRequestParam('use_filters', false, DataType::BOOL);
+			wp_redirect(
+				EE_Admin_Page::add_query_args_and_nonce(
+					[
+						'page'        => EED_Batch::PAGE_SLUG,
+						'batch'       => EED_Batch::batch_file_job,
+						'EVT_ID'      => $EVT_ID,
+						'filters'     => urlencode(serialize($this->$method_name_for_getting_query_params($filters))),
+						'use_filters' => urlencode($use_filters),
+						'job_handler' => urlencode('EventEspressoBatchRequest\JobHandlers\RegistrationsReport'),
+						'return_url'  => urlencode($return_url),
+					]
+				)
+			);
+		} else {
+			// Pull the current request params
+			$request_args = $this->request->requestParams();
+			// Set the required request_args to be passed to the export
+			$required_request_args = [
+				'export' => 'report',
+				'action' => 'registrations_report_for_event',
+				'EVT_ID' => $EVT_ID,
+			];
+			// Merge required request args, overriding any currently set
+			$request_args = array_merge($request_args, $required_request_args);
+			if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
+				require_once(EE_CLASSES . 'EE_Export.class.php');
+				$EE_Export = EE_Export::instance($request_args);
+				$EE_Export->export();
+			}
+		}
+	}
+
+
+	/**
+	 * Creates a registration report using only query parameters in the request
+	 *
+	 * @return void
+	 */
+	public function _registrations_report()
+	{
+		$this->_registrations_report_base('_get_registration_query_parameters');
+	}
+
+
+	public function _contact_list_export()
+	{
+		if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
+			require_once(EE_CLASSES . 'EE_Export.class.php');
+			$EE_Export = EE_Export::instance($this->request->requestParams());
+			$EE_Export->export_attendees();
+		}
+	}
+
+
+	public function _contact_list_report()
+	{
+		if (! defined('EE_USE_OLD_CSV_REPORT_CLASS')) {
+			wp_redirect(
+				EE_Admin_Page::add_query_args_and_nonce(
+					[
+						'page'        => EED_Batch::PAGE_SLUG,
+						'batch'       => EED_Batch::batch_file_job,
+						'job_handler' => urlencode('EventEspressoBatchRequest\JobHandlers\AttendeesReport'),
+						'return_url'  => urlencode($this->request->getRequestParam('return_url', '', DataType::URL)),
+					]
+				)
+			);
+		} else {
+			if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
+				require_once(EE_CLASSES . 'EE_Export.class.php');
+				$EE_Export = EE_Export::instance($this->request->requestParams());
+				$EE_Export->report_attendees();
+			}
+		}
+	}
+
+
+
+
+
+	/***************************************        ATTENDEE DETAILS        ***************************************/
+	/**
+	 * This duplicates the attendee object for the given incoming registration id and attendee_id.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _duplicate_attendee()
+	{
+		$REG_ID = $this->request->getRequestParam('_REG_ID', 0, 'int');
+		$action = $this->request->getRequestParam('return', 'default');
+		// verify we have necessary info
+		if (! $REG_ID) {
+			EE_Error::add_error(
+				esc_html__(
+					'Unable to create the contact for the registration because the required parameters are not present (_REG_ID )',
+					'event_espresso'
+				),
+				__FILE__,
+				__LINE__,
+				__FUNCTION__
+			);
+			$query_args = ['action' => $action];
+			$this->_redirect_after_action('', '', '', $query_args, true);
+		}
+		// okay necessary deets present... let's dupe the incoming attendee and attach to incoming registration.
+		$registration = $this->getRegistrationModel()->get_one_by_ID($REG_ID);
+		if (! $registration instanceof EE_Registration) {
+			throw new RuntimeException(
+				sprintf(
+					esc_html__(
+						'Unable to create the contact because a valid registration could not be retrieved for REG ID: %1$d',
+						'event_espresso'
+					),
+					$REG_ID
+				)
+			);
+		}
+		$attendee = $registration->attendee();
+		// remove relation of existing attendee on registration
+		$registration->_remove_relation_to($attendee, 'Attendee');
+		// new attendee
+		$new_attendee = clone $attendee;
+		$new_attendee->set('ATT_ID', 0);
+		$new_attendee->save();
+		// add new attendee to reg
+		$registration->_add_relation_to($new_attendee, 'Attendee');
+		EE_Error::add_success(
+			esc_html__(
+				'New Contact record created.  Now make any edits you wish to make for this contact.',
+				'event_espresso'
+			)
+		);
+		// redirect to edit page for attendee
+		$query_args = ['post' => $new_attendee->ID(), 'action' => 'edit_attendee'];
+		$this->_redirect_after_action('', '', '', $query_args, true);
+	}
+
+
+	/**
+	 * Callback invoked by parent EE_Admin_CPT class hooked in on `save_post` wp hook.
+	 *
+	 * @param int     $post_id
+	 * @param WP_Post $post
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws LogicException
+	 * @throws InvalidFormSubmissionException
+	 * @throws ReflectionException
+	 */
+	protected function _insert_update_cpt_item($post_id, $post)
+	{
+		$success  = true;
+		$attendee = $post instanceof WP_Post && $post->post_type === 'espresso_attendees'
+			? $this->getAttendeeModel()->get_one_by_ID($post_id)
+			: null;
+		// for attendee updates
+		if ($attendee instanceof EE_Attendee) {
+			// note we should only be UPDATING attendees at this point.
+			$fname          = $this->request->getRequestParam('ATT_fname', '');
+			$lname          = $this->request->getRequestParam('ATT_lname', '');
+			$updated_fields = [
+				'ATT_fname'     => $fname,
+				'ATT_lname'     => $lname,
+				'ATT_full_name' => "{$fname} {$lname}",
+				'ATT_address'   => $this->request->getRequestParam('ATT_address', ''),
+				'ATT_address2'  => $this->request->getRequestParam('ATT_address2', ''),
+				'ATT_city'      => $this->request->getRequestParam('ATT_city', ''),
+				'STA_ID'        => $this->request->getRequestParam('STA_ID', ''),
+				'CNT_ISO'       => $this->request->getRequestParam('CNT_ISO', ''),
+				'ATT_zip'       => $this->request->getRequestParam('ATT_zip', ''),
+			];
+			foreach ($updated_fields as $field => $value) {
+				$attendee->set($field, $value);
+			}
+
+			// process contact details metabox form handler (which will also save the attendee)
+			$contact_details_form = $this->getAttendeeContactDetailsMetaboxFormHandler($attendee);
+			$success              = $contact_details_form->process($this->request->requestParams());
+
+			$attendee_update_callbacks = apply_filters(
+				'FHEE__Registrations_Admin_Page__insert_update_cpt_item__attendee_update',
+				[]
+			);
+			foreach ($attendee_update_callbacks as $a_callback) {
+				if (false === call_user_func_array($a_callback, [$attendee, $this->request->requestParams()])) {
+					throw new EE_Error(
+						sprintf(
+							esc_html__(
+								'The %s callback given for the "FHEE__Registrations_Admin_Page__insert_update_cpt_item__attendee_update" filter is not a valid callback.  Please check the spelling.',
+								'event_espresso'
+							),
+							$a_callback
+						)
+					);
+				}
+			}
+		}
+
+		if ($success === false) {
+			EE_Error::add_error(
+				esc_html__(
+					'Something went wrong with updating the meta table data for the registration.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+	}
+
+
+	public function trash_cpt_item($post_id)
+	{
+	}
+
+
+	public function delete_cpt_item($post_id)
+	{
+	}
+
+
+	public function restore_cpt_item($post_id)
+	{
+	}
+
+
+	protected function _restore_cpt_item($post_id, $revision_id)
+	{
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since 4.10.2.p
+	 */
+	public function attendee_editor_metaboxes()
+	{
+		$this->verify_cpt_object();
+		remove_meta_box(
+			'postexcerpt',
+			$this->_cpt_routes[ $this->_req_action ],
+			'normal'
+		);
+		remove_meta_box('commentstatusdiv', $this->_cpt_routes[ $this->_req_action ], 'normal');
+		if (post_type_supports('espresso_attendees', 'excerpt')) {
+			$this->addMetaBox(
+				'postexcerpt',
+				esc_html__('Short Biography', 'event_espresso'),
+				'post_excerpt_meta_box',
+				$this->_cpt_routes[ $this->_req_action ]
+			);
+		}
+		if (post_type_supports('espresso_attendees', 'comments')) {
+			$this->addMetaBox(
+				'commentsdiv',
+				esc_html__('Notes on the Contact', 'event_espresso'),
+				'post_comment_meta_box',
+				$this->_cpt_routes[ $this->_req_action ],
+				'normal',
+				'core'
+			);
+		}
+		$this->addMetaBox(
+			'attendee_contact_info',
+			esc_html__('Contact Info', 'event_espresso'),
+			[$this, 'attendee_contact_info'],
+			$this->_cpt_routes[ $this->_req_action ],
+			'side',
+			'core'
+		);
+		$this->addMetaBox(
+			'attendee_details_address',
+			esc_html__('Address Details', 'event_espresso'),
+			[$this, 'attendee_address_details'],
+			$this->_cpt_routes[ $this->_req_action ],
+			'normal',
+			'core'
+		);
+		$this->addMetaBox(
+			'attendee_registrations',
+			esc_html__('Registrations for this Contact', 'event_espresso'),
+			[$this, 'attendee_registrations_meta_box'],
+			$this->_cpt_routes[ $this->_req_action ]
+		);
+	}
+
+
+	/**
+	 * Metabox for attendee contact info
+	 *
+	 * @param WP_Post $post wp post object
+	 * @return void attendee contact info ( and form )
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws LogicException
+	 * @throws DomainException
+	 */
+	public function attendee_contact_info($post)
+	{
+		// get attendee object ( should already have it )
+		$form = $this->getAttendeeContactDetailsMetaboxFormHandler($this->_cpt_model_obj);
+		$form->enqueueStylesAndScripts();
+		echo wp_kses($form->display(), AllowedTags::getWithFormTags());
+	}
+
+
+	/**
+	 * Return form handler for the contact details metabox
+	 *
+	 * @param EE_Attendee $attendee
+	 * @return AttendeeContactDetailsMetaboxFormHandler
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function getAttendeeContactDetailsMetaboxFormHandler(EE_Attendee $attendee)
+	{
+		return new AttendeeContactDetailsMetaboxFormHandler($attendee, EE_Registry::instance());
+	}
+
+
+	/**
+	 * Metabox for attendee details
+	 *
+	 * @param WP_Post $post wp post object
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function attendee_address_details($post)
+	{
+		// get attendee object (should already have it)
+		$this->_template_args['attendee']     = $this->_cpt_model_obj;
+		$this->_template_args['state_html']   = EEH_Form_Fields::generate_form_input(
+			new EE_Question_Form_Input(
+				EE_Question::new_instance(
+					[
+						'QST_ID'           => 0,
+						'QST_display_text' => esc_html__('State/Province', 'event_espresso'),
+						'QST_system'       => 'admin-state',
+					]
+				),
+				EE_Answer::new_instance(
+					[
+						'ANS_ID'    => 0,
+						'ANS_value' => $this->_cpt_model_obj->state_ID(),
+					]
+				),
+				[
+					'input_id'       => 'STA_ID',
+					'input_name'     => 'STA_ID',
+					'input_prefix'   => '',
+					'append_qstn_id' => false,
+				]
+			)
+		);
+		$this->_template_args['country_html'] = EEH_Form_Fields::generate_form_input(
+			new EE_Question_Form_Input(
+				EE_Question::new_instance(
+					[
+						'QST_ID'           => 0,
+						'QST_display_text' => esc_html__('Country', 'event_espresso'),
+						'QST_system'       => 'admin-country',
+					]
+				),
+				EE_Answer::new_instance(
+					[
+						'ANS_ID'    => 0,
+						'ANS_value' => $this->_cpt_model_obj->country_ID(),
+					]
+				),
+				[
+					'input_id'       => 'CNT_ISO',
+					'input_name'     => 'CNT_ISO',
+					'input_prefix'   => '',
+					'append_qstn_id' => false,
+				]
+			)
+		);
+		$template = REG_TEMPLATE_PATH . 'attendee_address_details_metabox_content.template.php';
+		EEH_Template::display_template($template, $this->_template_args);
+	}
+
+
+	/**
+	 * _attendee_details
+	 *
+	 * @param $post
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function attendee_registrations_meta_box($post)
+	{
+		$this->_template_args['attendee']      = $this->_cpt_model_obj;
+		$this->_template_args['registrations'] = $this->_cpt_model_obj->get_many_related('Registration');
+		$template = REG_TEMPLATE_PATH . 'attendee_registrations_main_meta_box.template.php';
+		EEH_Template::display_template($template, $this->_template_args);
+	}
+
+
+	/**
+	 * add in the form fields for the attendee edit
+	 *
+	 * @param WP_Post $post wp post object
+	 * @return void echos html for new form.
+	 * @throws DomainException
+	 */
+	public function after_title_form_fields($post)
+	{
+		if ($post->post_type === 'espresso_attendees') {
+			$template                  = REG_TEMPLATE_PATH . 'attendee_details_after_title_form_fields.template.php';
+			$template_args['attendee'] = $this->_cpt_model_obj;
+			EEH_Template::display_template($template, $template_args);
+		}
+	}
+
+
+	/**
+	 * _trash_or_restore_attendee
+	 *
+	 * @param boolean $trash - whether to move item to trash (TRUE) or restore it (FALSE)
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _trash_or_restore_attendees($trash = true)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$status = $trash ? 'trash' : 'publish';
+		// Checkboxes
+		if ($this->request->requestParamIsSet('checkbox')) {
+			$ATT_IDs = $this->request->getRequestParam('checkbox', [], 'int', true);
+			// if array has more than one element than success message should be plural
+			$success = count($ATT_IDs) > 1 ? 2 : 1;
+			// cycle thru checkboxes
+			foreach ($ATT_IDs as $ATT_ID) {
+				$updated = $this->getAttendeeModel()->update_by_ID(['status' => $status], $ATT_ID);
+				if (! $updated) {
+					$success = 0;
+				}
+			}
+		} else {
+			// grab single id and delete
+			$ATT_ID = $this->request->getRequestParam('ATT_ID', 0, 'int');
+			// update attendee
+			$success = $this->getAttendeeModel()->update_by_ID(['status' => $status], $ATT_ID) ? 1 : 0;
+		}
+		$what        = $success > 1
+			? esc_html__('Contacts', 'event_espresso')
+			: esc_html__('Contact', 'event_espresso');
+		$action_desc = $trash
+			? esc_html__('moved to the trash', 'event_espresso')
+			: esc_html__('restored', 'event_espresso');
+		$this->_redirect_after_action($success, $what, $action_desc, ['action' => 'contact_list']);
+	}
 }

Spacing +104 added lines, -104 removed lines

@@ -93,7 +93,7 @@ 
      */
     protected function getRegistrationModel()
     {
-        if (! $this->registration_model instanceof EEM_Registration) {
+        if ( ! $this->registration_model instanceof EEM_Registration) {
             $this->registration_model = $this->loader->getShared('EEM_Registration');
         }
         return $this->registration_model;
@@ -109,7 +109,7 @@ 
      */
     protected function getAttendeeModel()
     {
-        if (! $this->attendee_model instanceof EEM_Attendee) {
+        if ( ! $this->attendee_model instanceof EEM_Attendee) {
             $this->attendee_model = $this->loader->getShared('EEM_Attendee');
         }
         return $this->attendee_model;
@@ -125,7 +125,7 @@ 
      */
     protected function getEventModel()
     {
-        if (! $this->event_model instanceof EEM_Event) {
+        if ( ! $this->event_model instanceof EEM_Event) {
             $this->event_model = $this->loader->getShared('EEM_Event');
         }
         return $this->event_model;
@@ -141,7 +141,7 @@ 
      */
     protected function getStatusModel()
     {
-        if (! $this->status_model instanceof EEM_Status) {
+        if ( ! $this->status_model instanceof EEM_Status) {
             $this->status_model = $this->loader->getShared('EEM_Status');
         }
         return $this->status_model;
@@ -763,7 +763,7 @@ 
         // style
         wp_register_style(
             'espresso_reg',
-            REG_ASSETS_URL . 'espresso_registrations_admin.css',
+            REG_ASSETS_URL.'espresso_registrations_admin.css',
             ['ee-admin-css'],
             EVENT_ESPRESSO_VERSION
         );
@@ -771,7 +771,7 @@ 
         // script
         wp_register_script(
             'espresso_reg',
-            REG_ASSETS_URL . 'espresso_registrations_admin.js',
+            REG_ASSETS_URL.'espresso_registrations_admin.js',
             ['jquery-ui-datepicker', 'jquery-ui-draggable', 'ee_admin_js'],
             EVENT_ESPRESSO_VERSION,
             true
@@ -795,7 +795,7 @@ 
             'att_publish_text' => sprintf(
             /* translators: The date and time */
                 wp_strip_all_tags(__('Created on: %s', 'event_espresso')),
-                '<b>' . $this->_cpt_model_obj->get_datetime('ATT_created') . '</b>'
+                '<b>'.$this->_cpt_model_obj->get_datetime('ATT_created').'</b>'
             ),
         ];
         wp_localize_script('espresso_reg', 'ATTENDEE_DETAILS', $attendee_details_translations);
@@ -826,7 +826,7 @@ 
         wp_dequeue_style('espresso_reg');
         wp_register_style(
             'espresso_att',
-            REG_ASSETS_URL . 'espresso_attendees_admin.css',
+            REG_ASSETS_URL.'espresso_attendees_admin.css',
             ['ee-admin-css'],
             EVENT_ESPRESSO_VERSION
         );
@@ -838,7 +838,7 @@ 
     {
         wp_register_script(
             'ee-spco-for-admin',
-            REG_ASSETS_URL . 'spco_for_admin.js',
+            REG_ASSETS_URL.'spco_for_admin.js',
             ['underscore', 'jquery'],
             EVENT_ESPRESSO_VERSION,
             true
@@ -886,7 +886,7 @@ 
             'no_approve_registrations' => 'not_approved_registration',
             'cancel_registrations'     => 'cancelled_registration',
         ];
-        $can_send    = EE_Registry::instance()->CAP->current_user_can(
+        $can_send = EE_Registry::instance()->CAP->current_user_can(
             'ee_send_message',
             'batch_send_messages'
         );
@@ -991,7 +991,7 @@ 
                     'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'),
                 ],
             ];
-            $this->_views['trash']      = [
+            $this->_views['trash'] = [
                 'slug'        => 'trash',
                 'label'       => esc_html__('Trash', 'event_espresso'),
                 'count'       => 0,
@@ -1091,7 +1091,7 @@ 
         }
         $sc_items = [
             'approved_status'   => [
-                'class' => 'ee-status-legend ee-status-bg--' . EEM_Registration::status_id_approved,
+                'class' => 'ee-status-legend ee-status-bg--'.EEM_Registration::status_id_approved,
                 'desc'  => EEH_Template::pretty_status(
                     EEM_Registration::status_id_approved,
                     false,
@@ -1099,7 +1099,7 @@ 
                 ),
             ],
             'pending_status'    => [
-                'class' => 'ee-status-legend ee-status-bg--' . EEM_Registration::status_id_pending_payment,
+                'class' => 'ee-status-legend ee-status-bg--'.EEM_Registration::status_id_pending_payment,
                 'desc'  => EEH_Template::pretty_status(
                     EEM_Registration::status_id_pending_payment,
                     false,
@@ -1107,7 +1107,7 @@ 
                 ),
             ],
             'wait_list'         => [
-                'class' => 'ee-status-legend ee-status-bg--' . EEM_Registration::status_id_wait_list,
+                'class' => 'ee-status-legend ee-status-bg--'.EEM_Registration::status_id_wait_list,
                 'desc'  => EEH_Template::pretty_status(
                     EEM_Registration::status_id_wait_list,
                     false,
@@ -1115,7 +1115,7 @@ 
                 ),
             ],
             'incomplete_status' => [
-                'class' => 'ee-status-legend ee-status-bg--' . EEM_Registration::status_id_incomplete,
+                'class' => 'ee-status-legend ee-status-bg--'.EEM_Registration::status_id_incomplete,
                 'desc'  => EEH_Template::pretty_status(
                     EEM_Registration::status_id_incomplete,
                     false,
@@ -1123,7 +1123,7 @@ 
                 ),
             ],
             'not_approved'      => [
-                'class' => 'ee-status-legend ee-status-bg--' . EEM_Registration::status_id_not_approved,
+                'class' => 'ee-status-legend ee-status-bg--'.EEM_Registration::status_id_not_approved,
                 'desc'  => EEH_Template::pretty_status(
                     EEM_Registration::status_id_not_approved,
                     false,
@@ -1131,7 +1131,7 @@ 
                 ),
             ],
             'declined_status'   => [
-                'class' => 'ee-status-legend ee-status-bg--' . EEM_Registration::status_id_declined,
+                'class' => 'ee-status-legend ee-status-bg--'.EEM_Registration::status_id_declined,
                 'desc'  => EEH_Template::pretty_status(
                     EEM_Registration::status_id_declined,
                     false,
@@ -1139,7 +1139,7 @@ 
                 ),
             ],
             'cancelled_status'  => [
-                'class' => 'ee-status-legend ee-status-bg--' . EEM_Registration::status_id_cancelled,
+                'class' => 'ee-status-legend ee-status-bg--'.EEM_Registration::status_id_cancelled,
                 'desc'  => EEH_Template::pretty_status(
                     EEM_Registration::status_id_cancelled,
                     false,
@@ -1176,8 +1176,8 @@ 
             $filter_header_decorator = $this->loader->getNew($admin_page_header_decorator);
             $header_text = $filter_header_decorator->getHeaderText($header_text);
         }
-        $this->_template_args['before_list_table']  = $header_text;
-        $this->_template_args['after_list_table']  = $this->_display_legend($this->_registration_legend_items());
+        $this->_template_args['before_list_table'] = $header_text;
+        $this->_template_args['after_list_table'] = $this->_display_legend($this->_registration_legend_items());
         $this->display_admin_list_table_page_with_no_sidebar();
     }
 
@@ -1199,7 +1199,7 @@ 
                 $EVT_ID
             )
         ) {
-            $this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
+            $this->_admin_page_title .= ' '.$this->get_action_link_or_button(
                 'new_registration',
                 'add-registrant',
                 ['event_id' => $EVT_ID],
@@ -1357,7 +1357,7 @@ 
                 ],
                 REG_ADMIN_URL
             );
-            $this->_template_args['filtered_transactions_link']  = EE_Admin_Page::add_query_args_and_nonce(
+            $this->_template_args['filtered_transactions_link'] = EE_Admin_Page::add_query_args_and_nonce(
                 [
                     'action' => 'default',
                     'EVT_ID' => $event_id,
@@ -1365,7 +1365,7 @@ 
                 ],
                 admin_url('admin.php')
             );
-            $this->_template_args['event_link']                  = EE_Admin_Page::add_query_args_and_nonce(
+            $this->_template_args['event_link'] = EE_Admin_Page::add_query_args_and_nonce(
                 [
                     'page'   => 'espresso_events',
                     'action' => 'edit',
@@ -1374,12 +1374,12 @@ 
                 admin_url('admin.php')
             );
             // next and previous links
-            $next_reg                                      = $this->_registration->next(
+            $next_reg = $this->_registration->next(
                 null,
                 [],
                 'REG_ID'
             );
-            $this->_template_args['next_registration']     = $next_reg
+            $this->_template_args['next_registration'] = $next_reg
                 ? $this->_next_link(
                     EE_Admin_Page::add_query_args_and_nonce(
                         [
@@ -1391,7 +1391,7 @@ 
                     'dashicons dashicons-arrow-right ee-icon-size-22'
                 )
                 : '';
-            $previous_reg                                  = $this->_registration->previous(
+            $previous_reg = $this->_registration->previous(
                 null,
                 [],
                 'REG_ID'
@@ -1409,7 +1409,7 @@ 
                 )
                 : '';
             // grab header
-            $template_path                             = REG_TEMPLATE_PATH . 'reg_admin_details_header.template.php';
+            $template_path                             = REG_TEMPLATE_PATH.'reg_admin_details_header.template.php';
             $this->_template_args['REG_ID']            = $this->_registration->ID();
             $this->_template_args['admin_page_header'] = EEH_Template::display_template(
                 $template_path,
@@ -1446,7 +1446,7 @@ 
         );
         $this->addMetaBox(
             'edit-reg-details-mbox',
-            '<span>' . esc_html__('Registration Details', 'event_espresso')
+            '<span>'.esc_html__('Registration Details', 'event_espresso')
             . '&nbsp;<span class="dashicons dashicons-clipboard"></span></span>',
             [$this, '_reg_details_meta_box'],
             $this->_wp_page_slug
@@ -1550,7 +1550,7 @@ 
                 $this->_registration->ID()
             )
         ) {
-            $reg_status_change_form_array['subsections']['reg_status']         = new EE_Select_Input(
+            $reg_status_change_form_array['subsections']['reg_status'] = new EE_Select_Input(
                 $this->_get_reg_statuses(),
                 [
                     'html_label_text' => esc_html__('Change Registration Status to', 'event_espresso'),
@@ -1567,7 +1567,7 @@ 
                     ),
                 ]
             );
-            $reg_status_change_form_array['subsections']['submit']             = new EE_Submit_Input(
+            $reg_status_change_form_array['subsections']['submit'] = new EE_Submit_Input(
                 [
                     'html_class'      => 'button--primary',
                     'html_label_text' => '&nbsp;',
@@ -1592,7 +1592,7 @@ 
     protected function _get_reg_statuses()
     {
         $reg_status_array = $this->getRegistrationModel()->reg_status_array();
-        unset($reg_status_array[ EEM_Registration::status_id_incomplete ]);
+        unset($reg_status_array[EEM_Registration::status_id_incomplete]);
         // get current reg status
         $current_status = $this->_registration->status_ID();
         // is registration for free event? This will determine whether to display the pending payment option
@@ -1600,7 +1600,7 @@ 
             $current_status !== EEM_Registration::status_id_pending_payment
             && EEH_Money::compare_floats($this->_registration->ticket()->price(), 0.00)
         ) {
-            unset($reg_status_array[ EEM_Registration::status_id_pending_payment ]);
+            unset($reg_status_array[EEM_Registration::status_id_pending_payment]);
         }
         return $this->getStatusModel()->localized_status($reg_status_array, false, 'sentence');
     }
@@ -1691,7 +1691,7 @@ 
         $success = false;
         // typecast $REG_IDs
         $REG_IDs = (array) $REG_IDs;
-        if (! empty($REG_IDs)) {
+        if ( ! empty($REG_IDs)) {
             $success = true;
             // set default status if none is passed
             $status         = $status ?: EEM_Registration::status_id_pending_payment;
@@ -1851,7 +1851,7 @@ 
             $action,
             $notify
         );
-        $method = $action . '_registration';
+        $method = $action.'_registration';
         if (method_exists($this, $method)) {
             $this->$method($notify);
         }
@@ -2001,7 +2001,7 @@ 
         $filters        = new EE_Line_Item_Filter_Collection();
         $filters->add(new EE_Single_Registration_Line_Item_Filter($this->_registration));
         $filters->add(new EE_Non_Zero_Line_Item_Filter());
-        $line_item_filter_processor              = new EE_Line_Item_Filter_Processor(
+        $line_item_filter_processor = new EE_Line_Item_Filter_Processor(
             $filters,
             $transaction->total_line_item()
         );
@@ -2014,7 +2014,7 @@ 
             $filtered_line_item_tree,
             ['EE_Registration' => $this->_registration]
         );
-        $attendee                                = $this->_registration->attendee();
+        $attendee = $this->_registration->attendee();
         if (
             EE_Registry::instance()->CAP->current_user_can(
                 'ee_read_transaction',
@@ -2096,7 +2096,7 @@ 
                 'Payment method response',
                 'event_espresso'
             );
-            $this->_template_args['reg_details']['response_msg']['class']   = 'regular-text';
+            $this->_template_args['reg_details']['response_msg']['class'] = 'regular-text';
         }
         $this->_template_args['reg_details']['registration_session']['value'] = $reg_details['registration_session'];
         $this->_template_args['reg_details']['registration_session']['label'] = esc_html__(
@@ -2127,7 +2127,7 @@ 
         $this->_template_args['REG_ID'] = $this->_registration->ID();
         $this->_template_args['event_id'] = $this->_registration->event_ID();
 
-        $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_details.template.php';
+        $template_path = REG_TEMPLATE_PATH.'reg_admin_details_main_meta_box_reg_details.template.php';
         EEH_Template::display_template($template_path, $this->_template_args); // already escaped
     }
 
@@ -2166,7 +2166,7 @@ 
 
             $this->_template_args['reg_questions_form_action'] = 'edit_registration';
             $this->_template_args['REG_ID'] = $this->_registration->ID();
-            $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_questions.template.php';
+            $template_path = REG_TEMPLATE_PATH.'reg_admin_details_main_meta_box_reg_questions.template.php';
             EEH_Template::display_template($template_path, $this->_template_args);
         }
     }
@@ -2182,7 +2182,7 @@ 
     public function form_before_question_group($output)
     {
         EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
+            __CLASS__.'::'.__FUNCTION__,
             esc_html__(
                 'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.',
                 'event_espresso'
@@ -2206,7 +2206,7 @@ 
     public function form_after_question_group($output)
     {
         EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
+            __CLASS__.'::'.__FUNCTION__,
             esc_html__(
                 'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.',
                 'event_espresso'
@@ -2243,7 +2243,7 @@ 
     public function form_form_field_label_wrap($label)
     {
         EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
+            __CLASS__.'::'.__FUNCTION__,
             esc_html__(
                 'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.',
                 'event_espresso'
@@ -2253,7 +2253,7 @@ 
         return '
 			<tr>
 				<th>
-					' . $label . '
+					' . $label.'
 				</th>';
     }
 
@@ -2268,7 +2268,7 @@ 
     public function form_form_field_input__wrap($input)
     {
         EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
+            __CLASS__.'::'.__FUNCTION__,
             esc_html__(
                 'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.',
                 'event_espresso'
@@ -2277,7 +2277,7 @@ 
         );
         return '
 				<td class="reg-admin-attendee-questions-input-td disabled-input">
-					' . $input . '
+					' . $input.'
 				</td>
 			</tr>';
     }
@@ -2326,8 +2326,8 @@ 
      */
     protected function _get_reg_custom_questions_form($REG_ID)
     {
-        if (! $this->_reg_custom_questions_form) {
-            require_once(REG_ADMIN . 'form_sections/EE_Registration_Custom_Questions_Form.form.php');
+        if ( ! $this->_reg_custom_questions_form) {
+            require_once(REG_ADMIN.'form_sections/EE_Registration_Custom_Questions_Form.form.php');
             $this->_reg_custom_questions_form = new EE_Registration_Custom_Questions_Form(
                 $this->getRegistrationModel()->get_one_by_ID($REG_ID)
             );
@@ -2350,7 +2350,7 @@ 
      */
     private function _save_reg_custom_questions_form($REG_ID = 0)
     {
-        if (! $REG_ID) {
+        if ( ! $REG_ID) {
             EE_Error::add_error(
                 esc_html__(
                     'An error occurred. No registration ID was received.',
@@ -2367,7 +2367,7 @@ 
         if ($form->is_valid()) {
             foreach ($form->subforms() as $question_group_form) {
                 foreach ($question_group_form->inputs() as $question_id => $input) {
-                    $where_conditions    = [
+                    $where_conditions = [
                         'QST_ID' => $question_id,
                         'REG_ID' => $REG_ID,
                     ];
@@ -2408,7 +2408,7 @@ 
         $REG = $this->getRegistrationModel();
         // get all other registrations on this transaction, and cache
         // the attendees for them so we don't have to run another query using force_join
-        $registrations                           = $REG->get_all(
+        $registrations = $REG->get_all(
             [
                 [
                     'TXN_ID' => $this->_registration->transaction_ID(),
@@ -2442,23 +2442,23 @@ 
                 $attendee                                                      = $registration->attendee()
                     ? $registration->attendee()
                     : $this->getAttendeeModel()->create_default_object();
-                $this->_template_args['attendees'][ $att_nmbr ]['STS_ID']      = $registration->status_ID();
-                $this->_template_args['attendees'][ $att_nmbr ]['fname']       = $attendee->fname();
-                $this->_template_args['attendees'][ $att_nmbr ]['lname']       = $attendee->lname();
-                $this->_template_args['attendees'][ $att_nmbr ]['email']       = $attendee->email();
-                $this->_template_args['attendees'][ $att_nmbr ]['final_price'] = $registration->final_price();
-                $this->_template_args['attendees'][ $att_nmbr ]['address']     = implode(
+                $this->_template_args['attendees'][$att_nmbr]['STS_ID']      = $registration->status_ID();
+                $this->_template_args['attendees'][$att_nmbr]['fname']       = $attendee->fname();
+                $this->_template_args['attendees'][$att_nmbr]['lname']       = $attendee->lname();
+                $this->_template_args['attendees'][$att_nmbr]['email']       = $attendee->email();
+                $this->_template_args['attendees'][$att_nmbr]['final_price'] = $registration->final_price();
+                $this->_template_args['attendees'][$att_nmbr]['address']     = implode(
                     ', ',
                     $attendee->full_address_as_array()
                 );
-                $this->_template_args['attendees'][ $att_nmbr ]['att_link']    = self::add_query_args_and_nonce(
+                $this->_template_args['attendees'][$att_nmbr]['att_link'] = self::add_query_args_and_nonce(
                     [
                         'action' => 'edit_attendee',
                         'post'   => $attendee->ID(),
                     ],
                     REG_ADMIN_URL
                 );
-                $this->_template_args['attendees'][ $att_nmbr ]['event_name']  =
+                $this->_template_args['attendees'][$att_nmbr]['event_name'] =
                     $registration->event_obj() instanceof EE_Event
                         ? $registration->event_obj()->name()
                         : '';
@@ -2466,7 +2466,7 @@ 
             }
             $this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign;
         }
-        $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_attendees.template.php';
+        $template_path = REG_TEMPLATE_PATH.'reg_admin_details_main_meta_box_attendees.template.php';
         EEH_Template::display_template($template_path, $this->_template_args);
     }
 
@@ -2492,11 +2492,11 @@ 
         // now let's determine if this is not the primary registration.  If it isn't then we set the
         // primary_registration object for reference BUT ONLY if the Attendee object loaded is not the same as the
         // primary registration object (that way we know if we need to show create button or not)
-        if (! $this->_registration->is_primary_registrant()) {
+        if ( ! $this->_registration->is_primary_registrant()) {
             $primary_registration = $this->_registration->get_primary_registration();
             $primary_attendee     = $primary_registration instanceof EE_Registration ? $primary_registration->attendee()
                 : null;
-            if (! $primary_attendee instanceof EE_Attendee || $attendee->ID() !== $primary_attendee->ID()) {
+            if ( ! $primary_attendee instanceof EE_Attendee || $attendee->ID() !== $primary_attendee->ID()) {
                 // in here?  This means the displayed registration is not the primary registrant but ALREADY HAS its own
                 // custom attendee object so let's not worry about the primary reg.
                 $primary_registration = null;
@@ -2511,7 +2511,7 @@ 
         $this->_template_args['phone']             = $attendee->phone();
         $this->_template_args['formatted_address'] = EEH_Address::format($attendee);
         // edit link
-        $this->_template_args['att_edit_link']  = EE_Admin_Page::add_query_args_and_nonce(
+        $this->_template_args['att_edit_link'] = EE_Admin_Page::add_query_args_and_nonce(
             [
                 'action' => 'edit_attendee',
                 'post'   => $attendee->ID(),
@@ -2521,7 +2521,7 @@ 
         $this->_template_args['att_edit_title'] = esc_html__('View details for this contact.', 'event_espresso');
         $this->_template_args['att_edit_label'] = esc_html__('View/Edit Contact', 'event_espresso');
         // create link
-        $this->_template_args['create_link']  = $primary_registration instanceof EE_Registration
+        $this->_template_args['create_link'] = $primary_registration instanceof EE_Registration
             ? EE_Admin_Page::add_query_args_and_nonce(
                 [
                     'action'  => 'duplicate_attendee',
@@ -2531,7 +2531,7 @@ 
             ) : '';
         $this->_template_args['create_label'] = esc_html__('Create Contact', 'event_espresso');
         $this->_template_args['att_check'] = $att_check;
-        $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_side_meta_box_registrant.template.php';
+        $template_path = REG_TEMPLATE_PATH.'reg_admin_details_side_meta_box_registrant.template.php';
         EEH_Template::display_template($template_path, $this->_template_args);
     }
 
@@ -2575,7 +2575,7 @@ 
             /** @var EE_Registration $REG */
             $REG      = $this->getRegistrationModel()->get_one_by_ID($REG_ID);
             $payments = $REG->registration_payments();
-            if (! empty($payments)) {
+            if ( ! empty($payments)) {
                 $name           = $REG->attendee() instanceof EE_Attendee
                     ? $REG->attendee()->full_name()
                     : esc_html__('Unknown Attendee', 'event_espresso');
@@ -2639,17 +2639,17 @@ 
         // Checkboxes
         $REG_IDs = $this->request->getRequestParam('_REG_ID', [], 'int', true);
 
-        if (! empty($REG_IDs)) {
+        if ( ! empty($REG_IDs)) {
             // if array has more than one element than success message should be plural
             $success = count($REG_IDs) > 1 ? 2 : 1;
             // cycle thru checkboxes
             foreach ($REG_IDs as $REG_ID) {
                 $REG = $REG_MDL->get_one_by_ID($REG_ID);
-                if (! $REG instanceof EE_Registration) {
+                if ( ! $REG instanceof EE_Registration) {
                     continue;
                 }
                 $deleted = $this->_delete_registration($REG);
-                if (! $deleted) {
+                if ( ! $deleted) {
                     $success = 0;
                 }
             }
@@ -2686,7 +2686,7 @@ 
         // first we start with the transaction... ultimately, we WILL not delete permanently if there are any related
         // registrations on the transaction that are NOT trashed.
         $TXN = $REG->get_first_related('Transaction');
-        if (! $TXN instanceof EE_Transaction) {
+        if ( ! $TXN instanceof EE_Transaction) {
             EE_Error::add_error(
                 sprintf(
                     esc_html__(
@@ -2704,11 +2704,11 @@ 
         $REGS        = $TXN->get_many_related('Registration');
         $all_trashed = true;
         foreach ($REGS as $registration) {
-            if (! $registration->get('REG_deleted')) {
+            if ( ! $registration->get('REG_deleted')) {
                 $all_trashed = false;
             }
         }
-        if (! $all_trashed) {
+        if ( ! $all_trashed) {
             EE_Error::add_error(
                 esc_html__(
                     'Unable to permanently delete this registration. Before this registration can be permanently deleted, all registrations made in the same transaction must be trashed as well.  These registrations will be permanently deleted in the same action.',
@@ -2770,7 +2770,7 @@ 
      */
     public function new_registration()
     {
-        if (! $this->_set_reg_event()) {
+        if ( ! $this->_set_reg_event()) {
             throw new EE_Error(
                 esc_html__(
                     'Unable to continue with registering because there is no Event ID in the request',
@@ -2802,7 +2802,7 @@ 
                 ],
                 EVENTS_ADMIN_URL
             );
-            $edit_event_lnk                     = '<a href="'
+            $edit_event_lnk = '<a href="'
                                                   . $edit_event_url
                                                   . '" title="'
                                                   . esc_attr__('Edit ', 'event_espresso')
@@ -2819,7 +2819,7 @@ 
             $this->_return_json();
         }
         // grab header
-        $template_path = REG_TEMPLATE_PATH . 'reg_admin_register_new_attendee.template.php';
+        $template_path = REG_TEMPLATE_PATH.'reg_admin_register_new_attendee.template.php';
         $this->_template_args['admin_page_content'] = EEH_Template::display_template(
             $template_path,
             $this->_template_args,
@@ -2860,7 +2860,7 @@ 
                 '</b>'
             );
             return '
-	<div id="ee-add-reg-back-button-dv"><p>' . $warning_msg . '</p></div>
+	<div id="ee-add-reg-back-button-dv"><p>' . $warning_msg.'</p></div>
 	<script >
 		// WHOAH !!! it appears that someone is using the back button from the Transaction admin page
 		// after just adding a new registration... we gotta try to put a stop to that !!!
@@ -2927,7 +2927,7 @@ 
         // we come back to the process_registration_step route.
         $this->_set_add_edit_form_tags('process_reg_step', $hidden_fields);
         return EEH_Template::display_template(
-            REG_TEMPLATE_PATH . 'reg_admin_register_new_attendee_step_content.template.php',
+            REG_TEMPLATE_PATH.'reg_admin_register_new_attendee_step_content.template.php',
             $template_args,
             true
         );
@@ -2950,7 +2950,7 @@ 
         }
 
         $EVT_ID = $this->request->getRequestParam('event_id', 0, 'int');
-        if (! $EVT_ID) {
+        if ( ! $EVT_ID) {
             return false;
         }
         $this->_reg_event = $this->getEventModel()->get_one_by_ID($EVT_ID);
@@ -3020,7 +3020,7 @@ 
                 }
                 break;
             case 'questions':
-                if (! $this->request->requestParamIsSet('txn_reg_status_change[send_notifications]')) {
+                if ( ! $this->request->requestParamIsSet('txn_reg_status_change[send_notifications]')) {
                     add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_false', 15);
                 }
                 // process registration
@@ -3031,7 +3031,7 @@ 
                         $grand_total->save_this_and_descendants_to_txn();
                     }
                 }
-                if (! $transaction instanceof EE_Transaction) {
+                if ( ! $transaction instanceof EE_Transaction) {
                     $query_args = [
                         'action'                  => 'new_registration',
                         'processing_registration' => 2,
@@ -3053,7 +3053,7 @@ 
                     return;
                 }
                 // maybe update status, and make sure to save transaction if not done already
-                if (! $transaction->update_status_based_on_total_paid()) {
+                if ( ! $transaction->update_status_based_on_total_paid()) {
                     $transaction->save();
                 }
                 EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
@@ -3135,7 +3135,7 @@ 
     public function get_attendees($per_page, $count = false, $trash = false)
     {
         do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        require_once(REG_ADMIN . 'EE_Attendee_Contact_List_Table.class.php');
+        require_once(REG_ADMIN.'EE_Attendee_Contact_List_Table.class.php');
         $orderby = $this->request->getRequestParam('orderby');
         switch ($orderby) {
             case 'ATT_ID':
@@ -3158,7 +3158,7 @@ 
         $_where       = [];
         $search_term  = $this->request->getRequestParam('s');
         if ($search_term) {
-            $search_term  = '%' . $search_term . '%';
+            $search_term  = '%'.$search_term.'%';
             $_where['OR'] = [
                 'Registration.Event.EVT_name'       => ['LIKE', $search_term],
                 'Registration.Event.EVT_desc'       => ['LIKE', $search_term],
@@ -3185,7 +3185,7 @@ 
             'extra_selects' => ['Registration_Count' => ['Registration.REG_ID', 'count', '%d']],
             'limit'         => $limit,
         ];
-        if (! $count) {
+        if ( ! $count) {
             $query_args['order_by'] = [$orderby => $sort];
         }
         $query_args[0]['status'] = $trash ? ['!=', 'publish'] : ['IN', ['publish']];
@@ -3230,7 +3230,7 @@ 
         $EVT_ID = $this->request->requestParamIsSet('EVT_ID')
             ? $this->request->getRequestParam('EVT_ID', 0, DataType::INT)
             : null;
-        if (! defined('EE_USE_OLD_CSV_REPORT_CLASS')) {
+        if ( ! defined('EE_USE_OLD_CSV_REPORT_CLASS')) {
             $return_url = $this->request->getRequestParam('return_url', '', DataType::URL);
             $filters = $this->request->getRequestParam('filters', [], DataType::STRING, true);
             $use_filters = $this->request->getRequestParam('use_filters', false, DataType::BOOL);
@@ -3258,8 +3258,8 @@ 
             ];
             // Merge required request args, overriding any currently set
             $request_args = array_merge($request_args, $required_request_args);
-            if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
-                require_once(EE_CLASSES . 'EE_Export.class.php');
+            if (is_readable(EE_CLASSES.'EE_Export.class.php')) {
+                require_once(EE_CLASSES.'EE_Export.class.php');
                 $EE_Export = EE_Export::instance($request_args);
                 $EE_Export->export();
             }
@@ -3280,8 +3280,8 @@ 
 
     public function _contact_list_export()
     {
-        if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
-            require_once(EE_CLASSES . 'EE_Export.class.php');
+        if (is_readable(EE_CLASSES.'EE_Export.class.php')) {
+            require_once(EE_CLASSES.'EE_Export.class.php');
             $EE_Export = EE_Export::instance($this->request->requestParams());
             $EE_Export->export_attendees();
         }
@@ -3290,7 +3290,7 @@ 
 
     public function _contact_list_report()
     {
-        if (! defined('EE_USE_OLD_CSV_REPORT_CLASS')) {
+        if ( ! defined('EE_USE_OLD_CSV_REPORT_CLASS')) {
             wp_redirect(
                 EE_Admin_Page::add_query_args_and_nonce(
                     [
@@ -3302,8 +3302,8 @@ 
                 )
             );
         } else {
-            if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
-                require_once(EE_CLASSES . 'EE_Export.class.php');
+            if (is_readable(EE_CLASSES.'EE_Export.class.php')) {
+                require_once(EE_CLASSES.'EE_Export.class.php');
                 $EE_Export = EE_Export::instance($this->request->requestParams());
                 $EE_Export->report_attendees();
             }
@@ -3330,7 +3330,7 @@ 
         $REG_ID = $this->request->getRequestParam('_REG_ID', 0, 'int');
         $action = $this->request->getRequestParam('return', 'default');
         // verify we have necessary info
-        if (! $REG_ID) {
+        if ( ! $REG_ID) {
             EE_Error::add_error(
                 esc_html__(
                     'Unable to create the contact for the registration because the required parameters are not present (_REG_ID )',
@@ -3345,7 +3345,7 @@ 
         }
         // okay necessary deets present... let's dupe the incoming attendee and attach to incoming registration.
         $registration = $this->getRegistrationModel()->get_one_by_ID($REG_ID);
-        if (! $registration instanceof EE_Registration) {
+        if ( ! $registration instanceof EE_Registration) {
             throw new RuntimeException(
                 sprintf(
                     esc_html__(
@@ -3484,16 +3484,16 @@ 
         $this->verify_cpt_object();
         remove_meta_box(
             'postexcerpt',
-            $this->_cpt_routes[ $this->_req_action ],
+            $this->_cpt_routes[$this->_req_action],
             'normal'
         );
-        remove_meta_box('commentstatusdiv', $this->_cpt_routes[ $this->_req_action ], 'normal');
+        remove_meta_box('commentstatusdiv', $this->_cpt_routes[$this->_req_action], 'normal');
         if (post_type_supports('espresso_attendees', 'excerpt')) {
             $this->addMetaBox(
                 'postexcerpt',
                 esc_html__('Short Biography', 'event_espresso'),
                 'post_excerpt_meta_box',
-                $this->_cpt_routes[ $this->_req_action ]
+                $this->_cpt_routes[$this->_req_action]
             );
         }
         if (post_type_supports('espresso_attendees', 'comments')) {
@@ -3501,7 +3501,7 @@ 
                 'commentsdiv',
                 esc_html__('Notes on the Contact', 'event_espresso'),
                 'post_comment_meta_box',
-                $this->_cpt_routes[ $this->_req_action ],
+                $this->_cpt_routes[$this->_req_action],
                 'normal',
                 'core'
             );
@@ -3510,7 +3510,7 @@ 
             'attendee_contact_info',
             esc_html__('Contact Info', 'event_espresso'),
             [$this, 'attendee_contact_info'],
-            $this->_cpt_routes[ $this->_req_action ],
+            $this->_cpt_routes[$this->_req_action],
             'side',
             'core'
         );
@@ -3518,7 +3518,7 @@ 
             'attendee_details_address',
             esc_html__('Address Details', 'event_espresso'),
             [$this, 'attendee_address_details'],
-            $this->_cpt_routes[ $this->_req_action ],
+            $this->_cpt_routes[$this->_req_action],
             'normal',
             'core'
         );
@@ -3526,7 +3526,7 @@ 
             'attendee_registrations',
             esc_html__('Registrations for this Contact', 'event_espresso'),
             [$this, 'attendee_registrations_meta_box'],
-            $this->_cpt_routes[ $this->_req_action ]
+            $this->_cpt_routes[$this->_req_action]
         );
     }
 
@@ -3625,7 +3625,7 @@ 
                 ]
             )
         );
-        $template = REG_TEMPLATE_PATH . 'attendee_address_details_metabox_content.template.php';
+        $template = REG_TEMPLATE_PATH.'attendee_address_details_metabox_content.template.php';
         EEH_Template::display_template($template, $this->_template_args);
     }
 
@@ -3646,7 +3646,7 @@ 
     {
         $this->_template_args['attendee']      = $this->_cpt_model_obj;
         $this->_template_args['registrations'] = $this->_cpt_model_obj->get_many_related('Registration');
-        $template = REG_TEMPLATE_PATH . 'attendee_registrations_main_meta_box.template.php';
+        $template = REG_TEMPLATE_PATH.'attendee_registrations_main_meta_box.template.php';
         EEH_Template::display_template($template, $this->_template_args);
     }
 
@@ -3661,7 +3661,7 @@ 
     public function after_title_form_fields($post)
     {
         if ($post->post_type === 'espresso_attendees') {
-            $template                  = REG_TEMPLATE_PATH . 'attendee_details_after_title_form_fields.template.php';
+            $template                  = REG_TEMPLATE_PATH.'attendee_details_after_title_form_fields.template.php';
             $template_args['attendee'] = $this->_cpt_model_obj;
             EEH_Template::display_template($template, $template_args);
         }
@@ -3690,7 +3690,7 @@ 
             // cycle thru checkboxes
             foreach ($ATT_IDs as $ATT_ID) {
                 $updated = $this->getAttendeeModel()->update_by_ID(['status' => $status], $ATT_ID);
-                if (! $updated) {
+                if ( ! $updated) {
                     $success = 0;
                 }
             }

admin_pages/payments/Payments_Admin_Page.core.php

Indentation +1205 added lines, -1205 removed lines

@@ -16,1209 +16,1209 @@
  */
 class Payments_Admin_Page extends EE_Admin_Page
 {
-    /**
-     * Variables used for when we're re-sorting the logs results,
-     * in case we needed to do two queries, and we need to resort
-     *
-     * @var string
-     */
-    private $_sort_logs_again_direction;
-
-
-    /**
-     * @Constructor
-     * @access public
-     * @param bool $routing indicate whether we want to just load the object and handle routing or just load the object.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function __construct($routing = true)
-    {
-        parent::__construct($routing);
-    }
-
-
-    protected function _init_page_props()
-    {
-        $this->page_slug = EE_PAYMENTS_PG_SLUG;
-        $this->page_label = esc_html__('Payment Methods', 'event_espresso');
-        $this->_admin_base_url = EE_PAYMENTS_ADMIN_URL;
-        $this->_admin_base_path = EE_PAYMENTS_ADMIN;
-    }
-
-
-    protected function _ajax_hooks()
-    {
-        // todo: all hooks for ajax goes here.
-    }
-
-
-    protected function _define_page_props()
-    {
-        $this->_admin_page_title = $this->page_label;
-        $this->_labels = array(
-            'publishbox' => esc_html__('Update Settings', 'event_espresso'),
-        );
-    }
-
-
-    protected function _set_page_routes()
-    {
-        /**
-         * note that with payment method capabilities, although we've implemented
-         * capability mapping which will be used for accessing payment methods owned by
-         * other users.  This is not fully implemented yet in the payment method ui.
-         * Currently, only the "plural" caps are in active use.
-         * When cap mapping is implemented, some routes will need to use the singular form of
-         * capability method and also include the $id of the payment method for the route.
-         **/
-        $this->_page_routes = array(
-            'default'                   => array(
-                'func'       => '_payment_methods_list',
-                'capability' => 'ee_edit_payment_methods',
-            ),
-            'payment_settings'          => array(
-                'func'       => '_payment_settings',
-                'capability' => 'ee_manage_gateways',
-            ),
-            'activate_payment_method'   => array(
-                'func'       => '_activate_payment_method',
-                'noheader'   => true,
-                'capability' => 'ee_edit_payment_methods',
-            ),
-            'deactivate_payment_method' => array(
-                'func'       => '_deactivate_payment_method',
-                'noheader'   => true,
-                'capability' => 'ee_delete_payment_methods',
-            ),
-            'update_payment_method'     => array(
-                'func'               => '_update_payment_method',
-                'noheader'           => true,
-                'headers_sent_route' => 'default',
-                'capability'         => 'ee_edit_payment_methods',
-            ),
-            'update_payment_settings'   => array(
-                'func'       => '_update_payment_settings',
-                'noheader'   => true,
-                'capability' => 'ee_manage_gateways',
-            ),
-            'payment_log'               => array(
-                'func'       => '_payment_log_overview_list_table',
-                'capability' => 'ee_read_payment_methods',
-            ),
-            'payment_log_details'       => array(
-                'func'       => '_payment_log_details',
-                'capability' => 'ee_read_payment_methods',
-            ),
-        );
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _set_page_config()
-    {
-        $payment_method_list_config = array(
-            'nav'           => array(
-                'label' => esc_html__('Payment Methods', 'event_espresso'),
-                'icon' => 'dashicons-bank',
-                'order' => 10,
-            ),
-            'metaboxes'     => $this->_default_espresso_metaboxes,
-            'help_tabs'     => array_merge(
-                array(
-                    'payment_methods_overview_help_tab' => array(
-                        'title'    => esc_html__('Payment Methods Overview', 'event_espresso'),
-                        'filename' => 'payment_methods_overview',
-                    ),
-                ),
-                $this->_add_payment_method_help_tabs()
-            ),
-            'require_nonce' => false,
-        );
-        $this->_page_config = array(
-            'default'          => $payment_method_list_config,
-            'payment_settings' => array(
-                'nav'           => array(
-                    'label' => esc_html__('Settings', 'event_espresso'),
-                    'icon' => 'dashicons-admin-generic',
-                    'order' => 20,
-                ),
-                'help_tabs'     => array(
-                    'payment_methods_settings_help_tab' => array(
-                        'title'    => esc_html__('Payment Method Settings', 'event_espresso'),
-                        'filename' => 'payment_methods_settings',
-                    ),
-                ),
-                'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
-                'require_nonce' => false,
-            ),
-            'payment_log'      => array(
-                'nav'           => array(
-                    'label' => esc_html__("Logs", 'event_espresso'),
-                    'icon' => 'dashicons-text-page',
-                    'order' => 30,
-                ),
-                'list_table'    => 'Payment_Log_Admin_List_Table',
-                'metaboxes'     => $this->_default_espresso_metaboxes,
-                'require_nonce' => false,
-            ),
-        );
-    }
-
-
-    /**
-     * @return array
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _add_payment_method_help_tabs()
-    {
-        EE_Registry::instance()->load_lib('Payment_Method_Manager');
-        $payment_method_types = EE_Payment_Method_Manager::instance()->payment_method_types();
-        $all_pmt_help_tabs_config = array();
-        foreach ($payment_method_types as $payment_method_type) {
-            if (
-                ! EE_Registry::instance()->CAP->current_user_can(
-                    $payment_method_type->cap_name(),
-                    'specific_payment_method_type_access'
-                )
-            ) {
-                continue;
-            }
-            foreach ($payment_method_type->help_tabs_config() as $help_tab_name => $config) {
-                $template_args = isset($config['template_args']) ? $config['template_args'] : array();
-                $template_args['admin_page_obj'] = $this;
-                $all_pmt_help_tabs_config[ $help_tab_name ] = array(
-                    'title'   => $config['title'],
-                    'content' => EEH_Template::display_template(
-                        $payment_method_type->file_folder() . 'help_tabs/' . $config['filename'] . '.help_tab.php',
-                        $template_args,
-                        true
-                    ),
-                );
-            }
-        }
-        return $all_pmt_help_tabs_config;
-    }
-
-
-    // none of the below group are currently used for Gateway Settings
-    protected function _add_screen_options()
-    {
-    }
-
-
-    protected function _add_feature_pointers()
-    {
-    }
-
-
-    public function admin_init()
-    {
-    }
-
-
-    public function admin_notices()
-    {
-    }
-
-
-    public function admin_footer_scripts()
-    {
-    }
-
-
-    public function load_scripts_styles()
-    {
-        // styles
-        wp_enqueue_style('espresso-ui-theme');
-        wp_register_style(
-            'espresso_payments',
-            EE_PAYMENTS_ASSETS_URL . 'ee-payments.css',
-            [],
-            EVENT_ESPRESSO_VERSION
-        );
-        // scripts
-        wp_enqueue_script('ee_admin_js');
-        wp_enqueue_script('ee-text-links');
-        wp_enqueue_script(
-            'espresso_payments',
-            EE_PAYMENTS_ASSETS_URL . 'espresso_payments_admin.js',
-            ['ee-datepicker'],
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-    }
-
-
-    public function load_scripts_styles_default()
-    {
-        wp_enqueue_style('espresso_payments');
-        wp_enqueue_style('ee-text-links');
-    }
-
-
-    public function load_scripts_styles_payment_log_details()
-    {
-        wp_enqueue_style('espresso_payments');
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _payment_methods_list()
-    {
-        /**
-         * first let's ensure payment methods have been set up.
-         * We do this here because when people activate a payment method for the first time (as an addon),
-         * it may not set up its capabilities or get registered correctly due to the loading process.
-         * However, people MUST set up the details for the payment method,
-         * so it's safe to do a recheck here.
-         */
-        EE_Registry::instance()->load_lib('Payment_Method_Manager');
-        EEM_Payment_Method::instance()->verify_button_urls();
-        // set up tabs, one for each payment method type
-        $tabs = array();
-        $payment_methods = array();
-        foreach (EE_Payment_Method_Manager::instance()->payment_method_types() as $pmt_obj) {
-            // we don't want to show admin-only PMTs for now
-            if ($pmt_obj instanceof EE_PMT_Admin_Only) {
-                continue;
-            }
-            // check access
-            if (
-                ! EE_Registry::instance()->CAP->current_user_can(
-                    $pmt_obj->cap_name(),
-                    'specific_payment_method_type_access'
-                )
-            ) {
-                continue;
-            }
-            // check for any active pms of that type
-            $payment_method = EEM_Payment_Method::instance()->get_one_of_type($pmt_obj->system_name());
-            if (! $payment_method instanceof EE_Payment_Method) {
-                $payment_method = EE_Payment_Method::new_instance(
-                    array(
-                        'PMD_slug'       => sanitize_key($pmt_obj->system_name()),
-                        'PMD_type'       => $pmt_obj->system_name(),
-                        'PMD_name'       => $pmt_obj->pretty_name(),
-                        'PMD_admin_name' => $pmt_obj->pretty_name(),
-                    )
-                );
-            }
-            $payment_methods[ $payment_method->slug() ] = $payment_method;
-        }
-        $payment_methods = apply_filters(
-            'FHEE__Payments_Admin_Page___payment_methods_list__payment_methods',
-            $payment_methods
-        );
-        foreach ($payment_methods as $payment_method) {
-            if ($payment_method instanceof EE_Payment_Method) {
-                $this->addMetaBox(
-                    // html id
-                    'espresso_' . $payment_method->slug() . '_payment_settings',
-                    // title
-                    sprintf(esc_html__('%s Settings', 'event_espresso'), $payment_method->admin_name()),
-                    // callback
-                    array($this, 'payment_method_settings_meta_box'),
-                    // post type
-                    null,
-                    // context
-                    'normal',
-                    // priority
-                    'default',
-                    // callback args
-                    array('payment_method' => $payment_method)
-                );
-                // setup for tabbed content
-                $tabs[ $payment_method->slug() ] = array(
-                    'label' => $payment_method->admin_name(),
-                    'class' => $payment_method->active() ? 'gateway-active' : '',
-                    'href'  => 'espresso_' . $payment_method->slug() . '_payment_settings',
-                    'title' => esc_html__('Modify this Payment Method', 'event_espresso'),
-                    'slug'  => $payment_method->slug(),
-                    'icon'  => $payment_method->active()
-                        ? '<span class="dashicons dashicons-yes-alt"></span>'
-                        : '<span class="dashicons dashicons-remove"></span>',
-                );
-            }
-        }
-        $this->_template_args['admin_page_header'] = EEH_Tabbed_Content::tab_text_links(
-            $tabs,
-            'payment_method_links',
-            '',
-            $this->_get_active_payment_method_slug()
-        );
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     *   _get_active_payment_method_slug
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    protected function _get_active_payment_method_slug()
-    {
-        $payment_method_slug = false;
-        // decide which payment method tab to open first, as dictated by the request's 'payment_method'
-        if (isset($this->_req_data['payment_method'])) {
-            // if they provided the current payment method, use it
-            $payment_method_slug = sanitize_key($this->_req_data['payment_method']);
-        }
-        /** @var EE_Payment_Method $payment_method */
-        $payment_method = EEM_Payment_Method::instance()->get_one(array(array('PMD_slug' => $payment_method_slug)));
-        // if that didn't work or wasn't provided, find another way to select the current pm
-        if (! $this->_verify_payment_method($payment_method)) {
-            // like, looking for an active one
-            $payment_method = EEM_Payment_Method::instance()->get_one_active('CART');
-            // test that one as well
-            if ($this->_verify_payment_method($payment_method)) {
-                $payment_method_slug = $payment_method->slug();
-            } else {
-                $payment_method_slug = 'paypal_standard';
-            }
-        }
-        return $payment_method_slug;
-    }
-
-
-    /**
-     *    payment_method_settings_meta_box
-     *    returns TRUE if the passed payment method is properly constructed and the logged-in user has the correct
-     *    capabilities to access it
-     *
-     * @param EE_Payment_Method $payment_method
-     * @return boolean
-     * @throws EE_Error
-     */
-    protected function _verify_payment_method($payment_method)
-    {
-        if (
-            $payment_method instanceof EE_Payment_Method && $payment_method->type_obj() instanceof EE_PMT_Base
-            && EE_Registry::instance()->CAP->current_user_can(
-                $payment_method->type_obj()->cap_name(),
-                'specific_payment_method_type_access'
-            )
-        ) {
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     *    payment_method_settings_meta_box
-     *
-     * @param NULL  $post_obj_which_is_null is an object containing the current post (as a $post object)
-     * @param array $metabox                is an array with metabox id, title, callback, and args elements. the value
-     *                                      at 'args' has key 'payment_method', as set within _payment_methods_list
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function payment_method_settings_meta_box($post_obj_which_is_null, $metabox)
-    {
-        $payment_method = isset($metabox['args'], $metabox['args']['payment_method'])
-            ? $metabox['args']['payment_method'] : null;
-        if (! $payment_method instanceof EE_Payment_Method) {
-            throw new EE_Error(
-                esc_html__(
-                    'Payment method metabox setup incorrectly. No Payment method object was supplied',
-                    'event_espresso'
-                )
-            );
-        }
-        $payment_method_scopes = $payment_method->active();
-        // if the payment method really exists show its form, otherwise the activation template
-        if ($payment_method->ID() && ! empty($payment_method_scopes)) {
-            $form = $this->_generate_payment_method_settings_form($payment_method);
-            if ($form->form_data_present_in($this->_req_data)) {
-                $form->receive_form_submission($this->_req_data);
-            }
-            echo wp_kses($form->form_open() . $form->get_html_and_js() . $form->form_close(), AllowedTags::getWithFormTags());
-        } else {
-            echo wp_kses($this->_activate_payment_method_button($payment_method)->get_html_and_js(), AllowedTags::getWithFormTags());
-        }
-    }
-
-
-    /**
-     * Gets the form for all the settings related to this payment method type
-     *
-     * @access protected
-     * @param EE_Payment_Method $payment_method
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     */
-    protected function _generate_payment_method_settings_form(EE_Payment_Method $payment_method = null)
-    {
-        if (! $payment_method instanceof EE_Payment_Method) {
-            return new EE_Form_Section_Proper();
-        }
-        return new EE_Form_Section_Proper(
-            array(
-                'name'            => $payment_method->slug() . '_settings_form',
-                'html_id'         => $payment_method->slug() . '_settings_form',
-                'action'          => EE_Admin_Page::add_query_args_and_nonce(
-                    array(
-                        'action'         => 'update_payment_method',
-                        'payment_method' => $payment_method->slug(),
-                    ),
-                    EE_PAYMENTS_ADMIN_URL
-                ),
-                'layout_strategy' => new EE_Admin_Two_Column_Layout(),
-                'subsections'     => apply_filters(
-                    'FHEE__Payments_Admin_Page___generate_payment_method_settings_form__form_subsections',
-                    array(
-                        'pci_dss_compliance'      => $this->_pci_dss_compliance($payment_method),
-                        'currency_support'        => $this->_currency_support($payment_method),
-                        'payment_method_settings' => $this->_payment_method_settings($payment_method),
-                        'update'                  => $this->_update_payment_method_button($payment_method),
-                        'deactivate'              => $this->_deactivate_payment_method_button($payment_method),
-                        'fine_print'              => $this->_fine_print(),
-                    ),
-                    $payment_method
-                ),
-            )
-        );
-    }
-
-
-    /**
-     * _pci_dss_compliance
-     *
-     * @access protected
-     * @param EE_Payment_Method $payment_method
-     * @return EE_Form_Section_HTML
-     * @throws EE_Error
-     */
-    protected function _pci_dss_compliance(EE_Payment_Method $payment_method)
-    {
-        if ($payment_method->type_obj()->requires_https()) {
-            return new EE_Form_Section_HTML(
-                EEH_HTML::table(
-                    EEH_HTML::tr(
-                        EEH_HTML::th(
-                            EEH_HTML::label(
-                                EEH_HTML::strong(
-                                    esc_html__('IMPORTANT', 'event_espresso'),
-                                    '',
-                                    'important-notice'
-                                )
-                            )
-                        ) .
-                        EEH_HTML::td(
-                            EEH_HTML::strong(
-                                esc_html__(
-                                    'You are responsible for your own website security and Payment Card Industry Data Security Standards (PCI DSS) compliance.',
-                                    'event_espresso'
-                                )
-                            )
-                            .
-                            EEH_HTML::br()
-                            .
-                            esc_html__('Learn more about ', 'event_espresso')
-                            . EEH_HTML::link(
-                                'https://www.pcisecuritystandards.org/merchants/index.php',
-                                esc_html__('PCI DSS compliance', 'event_espresso')
-                            )
-                        )
-                    )
-                )
-            );
-        }
-        return new EE_Form_Section_HTML('');
-    }
-
-
-    /**
-     * _currency_support
-     *
-     * @access protected
-     * @param EE_Payment_Method $payment_method
-     * @return EE_Form_Section_HTML
-     * @throws EE_Error
-     */
-    protected function _currency_support(EE_Payment_Method $payment_method)
-    {
-        if (! $payment_method->usable_for_currency(EE_Config::instance()->currency->code)) {
-            return new EE_Form_Section_HTML(
-                EEH_HTML::table(
-                    EEH_HTML::tr(
-                        EEH_HTML::th(
-                            EEH_HTML::label(
-                                EEH_HTML::strong(
-                                    esc_html__('IMPORTANT', 'event_espresso'),
-                                    '',
-                                    'important-notice'
-                                )
-                            )
-                        ) .
-                        EEH_HTML::td(
-                            EEH_HTML::strong(
-                                sprintf(
-                                    esc_html__(
-                                        'This payment method does not support the currency set on your site (%1$s). Please activate a different payment method or change your site\'s country and associated currency.',
-                                        'event_espresso'
-                                    ),
-                                    EE_Config::instance()->currency->code
-                                )
-                            )
-                        )
-                    )
-                )
-            );
-        }
-        return new EE_Form_Section_HTML('');
-    }
-
-
-    /**
-     * _update_payment_method_button
-     *
-     * @access protected
-     * @param EE_Payment_Method $payment_method
-     * @return EE_Payment_Method_Form
-     * @throws EE_Error
-     */
-    protected function _payment_method_settings(EE_Payment_Method $payment_method)
-    {
-        // modify the form, so we only have/show fields that will be implemented for this version
-        return $this->_simplify_form($payment_method->type_obj()->settings_form(), $payment_method->name());
-    }
-
-
-    /**
-     * Simplifies the form to merely reproduce 4.1's gateway settings functionality
-     *
-     * @param EE_Form_Section_Proper $form_section
-     * @param string                 $payment_method_name
-     * @return EE_Payment_Method_Form
-     * @throws EE_Error
-     */
-    protected function _simplify_form($form_section, $payment_method_name = '')
-    {
-        if ($form_section instanceof EE_Payment_Method_Form) {
-            $form_section->exclude(
-                array(
-                    'PMD_type', // don't want them changing the type
-                    'PMD_slug', // or the slug (probably never)
-                    'PMD_wp_user', // or the user's ID
-                    'Currency' // or the currency, until the rest of EE supports simultaneous currencies
-                )
-            );
-            return $form_section;
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'The EE_Payment_Method_Form for the "%1$s" payment method is missing or invalid.',
-                        'event_espresso'
-                    ),
-                    $payment_method_name
-                )
-            );
-        }
-    }
-
-
-    /**
-     * _update_payment_method_button
-     *
-     * @access protected
-     * @param EE_Payment_Method $payment_method
-     * @return EE_Form_Section_HTML
-     * @throws EE_Error
-     */
-    protected function _update_payment_method_button(EE_Payment_Method $payment_method)
-    {
-        $update_button = new EE_Submit_Input(
-            array(
-                'name'       => 'submit',
-                'html_id'    => 'save_' . $payment_method->slug() . '_settings',
-                'default'    => sprintf(
-                    esc_html__('Update %s Payment Settings', 'event_espresso'),
-                    $payment_method->admin_name()
-                ),
-                'html_label' => EEH_HTML::nbsp(),
-            )
-        );
-        return new EE_Form_Section_HTML(
-            EEH_HTML::table(
-                EEH_HTML::no_row(EEH_HTML::br(2)) .
-                EEH_HTML::tr(
-                    EEH_HTML::th(esc_html__('Update Settings', 'event_espresso')) .
-                    EEH_HTML::td(
-                        $update_button->get_html_for_input()
-                    )
-                )
-            )
-        );
-    }
-
-
-    /**
-     * _deactivate_payment_method_button
-     *
-     * @access protected
-     * @param EE_Payment_Method $payment_method
-     * @return EE_Form_Section_HTML
-     */
-    protected function _deactivate_payment_method_button(EE_Payment_Method $payment_method)
-    {
-        $link_text_and_title = sprintf(
-            esc_html__('Deactivate %1$s Payments?', 'event_espresso'),
-            $payment_method->admin_name()
-        );
-        return new EE_Form_Section_HTML(
-            EEH_HTML::table(
-                EEH_HTML::tr(
-                    EEH_HTML::th(esc_html__('Deactivate Payment Method', 'event_espresso')) .
-                    EEH_HTML::td(
-                        EEH_HTML::link(
-                            EE_Admin_Page::add_query_args_and_nonce(
-                                array(
-                                    'action'         => 'deactivate_payment_method',
-                                    'payment_method' => $payment_method->slug(),
-                                ),
-                                EE_PAYMENTS_ADMIN_URL
-                            ),
-                            $link_text_and_title,
-                            $link_text_and_title,
-                            'deactivate_' . $payment_method->slug(),
-                            'button button--secondary'
-                        )
-                    )
-                )
-            )
-        );
-    }
-
-
-    /**
-     * _activate_payment_method_button
-     *
-     * @access protected
-     * @param EE_Payment_Method $payment_method
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     */
-    protected function _activate_payment_method_button(EE_Payment_Method $payment_method)
-    {
-        $link_text_and_title = sprintf(
-            esc_html__('Activate %1$s Payment Method?', 'event_espresso'),
-            $payment_method->admin_name()
-        );
-        return new EE_Form_Section_Proper(
-            array(
-                'name'            => 'activate_' . $payment_method->slug() . '_settings_form',
-                'html_id'         => 'activate_' . $payment_method->slug() . '_settings_form',
-                'action'          => '#',
-                'layout_strategy' => new EE_Admin_Two_Column_Layout(),
-                'subsections'     => apply_filters(
-                    'FHEE__Payments_Admin_Page___activate_payment_method_button__form_subsections',
-                    array(
-                        new EE_Form_Section_HTML(
-                            EEH_HTML::table(
-                                EEH_HTML::tr(
-                                    EEH_HTML::td(
-                                        $payment_method->type_obj()->introductory_html(),
-                                        '',
-                                        '',
-                                        '',
-                                        'colspan="2"'
-                                    )
-                                ) .
-                                EEH_HTML::tr(
-                                    EEH_HTML::th(
-                                        EEH_HTML::label(esc_html__('Click to Activate ', 'event_espresso'))
-                                    ) .
-                                    EEH_HTML::td(
-                                        EEH_HTML::link(
-                                            EE_Admin_Page::add_query_args_and_nonce(
-                                                array(
-                                                    'action'              => 'activate_payment_method',
-                                                    'payment_method_type' => $payment_method->type(),
-                                                ),
-                                                EE_PAYMENTS_ADMIN_URL
-                                            ),
-                                            $link_text_and_title,
-                                            $link_text_and_title,
-                                            'activate_' . $payment_method->slug(),
-                                            'button button--primary-alt'
-                                        )
-                                    )
-                                )
-                            )
-                        ),
-                    ),
-                    $payment_method
-                ),
-            )
-        );
-    }
-
-
-    /**
-     * _fine_print
-     *
-     * @access protected
-     * @return EE_Form_Section_HTML
-     */
-    protected function _fine_print()
-    {
-        return new EE_Form_Section_HTML(
-            EEH_HTML::table(
-                EEH_HTML::tr(
-                    EEH_HTML::th() .
-                    EEH_HTML::td(
-                        EEH_HTML::p(esc_html__('All fields marked with a * are required fields', 'event_espresso'), '', 'grey-text')
-                    )
-                )
-            )
-        );
-    }
-
-
-    /**
-     * Activates a payment method of that type. Mostly assuming there is only 1 of that type (or none so far)
-     *
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @global WP_User $current_user
-     */
-    protected function _activate_payment_method()
-    {
-        if (isset($this->_req_data['payment_method_type'])) {
-            $payment_method_type = sanitize_text_field($this->_req_data['payment_method_type']);
-            // see if one exists
-            EE_Registry::instance()->load_lib('Payment_Method_Manager');
-            $payment_method = EE_Payment_Method_Manager::instance()
-                                                       ->activate_a_payment_method_of_type($payment_method_type);
-            $this->_redirect_after_action(
-                1,
-                'Payment Method',
-                'activated',
-                array('action' => 'default', 'payment_method' => $payment_method->slug())
-            );
-        } else {
-            $this->_redirect_after_action(false, 'Payment Method', 'activated', array('action' => 'default'));
-        }
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _deactivate_payment_method()
-    {
-        if (isset($this->_req_data['payment_method'])) {
-            $payment_method_slug = sanitize_key($this->_req_data['payment_method']);
-            // deactivate it
-            EE_Registry::instance()->load_lib('Payment_Method_Manager');
-            $count_updated = EE_Payment_Method_Manager::instance()->deactivate_payment_method($payment_method_slug);
-            $this->_redirect_after_action(
-                $count_updated,
-                'Payment Method',
-                'deactivated',
-                array('action' => 'default', 'payment_method' => $payment_method_slug)
-            );
-        } else {
-            $this->_redirect_after_action(false, 'Payment Method', 'deactivated', array('action' => 'default'));
-        }
-    }
-
-
-    /**
-     * Processes the payment method form that was submitted. This is slightly trickier than usual form
-     * processing because we first need to identify WHICH form was processed and which payment method
-     * it corresponds to. Once we have done that, we see if the form is valid. If it is, the
-     * form's data is saved, and we redirect to the default payment methods page, setting the updated payment method
-     * as the currently-selected one. If it DOESN'T validate, we render the page with the form's errors (in the
-     * subsequently called 'headers_sent_func' which is _payment_methods_list)
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _update_payment_method()
-    {
-        if ($_SERVER['REQUEST_METHOD'] == 'POST') {
-            // ok let's find which gateway form to use based on the form input
-            EE_Registry::instance()->load_lib('Payment_Method_Manager');
-            /** @var $correct_pmt_form_to_use EE_Payment_Method_Form */
-            $correct_pmt_form_to_use = null;
-            $payment_method = null;
-            foreach (EEM_Payment_Method::instance()->get_all() as $payment_method) {
-                if ($payment_method instanceof EE_Payment_Method) {
-                    // get the form and simplify it, like what we do when we display it
-                    $pmt_form = $this->_generate_payment_method_settings_form($payment_method);
-                    if ($pmt_form->form_data_present_in($this->_req_data)) {
-                        $correct_pmt_form_to_use = $pmt_form;
-                        break;
-                    }
-                }
-            }
-            // if we couldn't find the correct payment method type...
-            if (! $correct_pmt_form_to_use) {
-                EE_Error::add_error(
-                    esc_html__(
-                        "We could not find which payment method type your form submission related to. Please contact support",
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                $this->_redirect_after_action(false, 'Payment Method', 'activated', array('action' => 'default'));
-            }
-            $correct_pmt_form_to_use->receive_form_submission($this->_req_data);
-            if ($correct_pmt_form_to_use->is_valid()) {
-                $payment_settings_subform = $correct_pmt_form_to_use->get_subsection('payment_method_settings');
-                if (! $payment_settings_subform instanceof EE_Payment_Method_Form) {
-                    throw new EE_Error(
-                        sprintf(
-                            esc_html__(
-                                'The payment method could not be saved because the form sections were misnamed. We expected to find %1$s, but did not.',
-                                'event_espresso'
-                            ),
-                            'payment_method_settings'
-                        )
-                    );
-                }
-                $payment_settings_subform->save();
-                /** @var $pm EE_Payment_Method */
-                $this->_redirect_after_action(
-                    true,
-                    'Payment Method',
-                    'updated',
-                    array('action' => 'default', 'payment_method' => $payment_method->slug())
-                );
-            } else {
-                EE_Error::add_error(
-                    sprintf(
-                        esc_html__(
-                            'Payment method of type %s was not saved because there were validation errors. They have been marked in the form',
-                            'event_espresso'
-                        ),
-                        $payment_method instanceof EE_Payment_Method ? $payment_method->type_obj()->pretty_name()
-                            : esc_html__('"(unknown)"', 'event_espresso')
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        }
-    }
-
-
-    /**
-     * Displays payment settings (not payment METHOD settings, that's _payment_method_settings)
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _payment_settings()
-    {
-        $form = $this->getPaymentSettingsForm();
-        $this->_set_add_edit_form_tags('update_payment_settings');
-        $this->_set_publish_post_box_vars(null, false, false, null, false);
-        $this->_template_args['admin_page_content'] = EEH_HTML::div(
-            $form->get_html_and_js(),
-            '',
-            'padding'
-        );
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     *        _update_payment_settings
-     *
-     * @access protected
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _update_payment_settings()
-    {
-        $form = $this->getPaymentSettingsForm();
-        if ($form->was_submitted($this->_req_data)) {
-            $form->receive_form_submission($this->_req_data);
-            if ($form->is_valid()) {
-                /**
-                 * @var $reg_config EE_Registration_Config
-                 */
-                $loader = LoaderFactory::getLoader();
-                $reg_config = $loader->getShared('EE_Registration_Config');
-                $valid_data = $form->valid_data();
-                $reg_config->show_pending_payment_options = $valid_data['show_pending_payment_options'];
-                $reg_config->gateway_log_lifespan = $valid_data['gateway_log_lifespan'];
-            }
-        }
-        EE_Registry::instance()->CFG = apply_filters(
-            'FHEE__Payments_Admin_Page___update_payment_settings__CFG',
-            EE_Registry::instance()->CFG
-        );
-
-        $what = esc_html__('Payment Settings', 'event_espresso');
-        $success = $this->_update_espresso_configuration(
-            $what,
-            EE_Registry::instance()->CFG,
-            __FILE__,
-            __FUNCTION__,
-            __LINE__
-        );
-        $this->_redirect_after_action(
-            $success,
-            $what,
-            esc_html__('updated', 'event_espresso'),
-            array('action' => 'payment_settings')
-        );
-    }
-
-
-    /**
-     * Gets the form used for updating payment settings
-     *
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function getPaymentSettingsForm()
-    {
-        /**
-         * @var $reg_config EE_Registration_Config
-         */
-        $reg_config = LoaderFactory::getLoader()->getShared('EE_Registration_Config');
-        return new EE_Form_Section_Proper(
-            array(
-                'name' => 'payment-settings',
-                'layout_strategy' => new EE_Admin_Two_Column_Layout(),
-                'subsections' => array(
-                    'show_pending_payment_options' => new EE_Yes_No_Input(
-                        array(
-                            'html_name' => 'show_pending_payment_options',
-                            'default' => $reg_config->show_pending_payment_options,
-                            'html_help_text' => esc_html__(
-                                "If a payment is marked as 'Pending Payment', or if payment is deferred (ie, an offline gateway like Check, Bank, or Invoice is used), then give registrants the option to retry payment. ",
-                                'event_espresso'
-                            )
-                        )
-                    ),
-                    'gateway_log_lifespan' => new EE_Select_Input(
-                        $reg_config->gatewayLogLifespanOptions(),
-                        array(
-                            'html_label_text' => esc_html__('Gateway Logs Lifespan', 'event_espresso'),
-                            'html_help_text' => esc_html__('If issues arise with payments being made through a payment gateway, it\'s helpful to log non-sensitive communications with the payment gateway. But it\'s a security responsibility, so it\'s a good idea to not keep them for any longer than necessary.', 'event_espresso'),
-                            'default' => $reg_config->gateway_log_lifespan,
-                        )
-                    )
-                )
-            )
-        );
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    protected function _payment_log_overview_list_table()
-    {
-        $this->display_admin_list_table_page_with_sidebar();
-    }
-
-
-    protected function _set_list_table_views_payment_log()
-    {
-        $this->_views = array(
-            'all' => array(
-                'slug'  => 'all',
-                'label' => esc_html__('View All Logs', 'event_espresso'),
-                'count' => 0,
-            ),
-        );
-    }
-
-
-    /**
-     * @param int  $per_page
-     * @param int  $current_page
-     * @param bool $count
-     * @return array|int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_payment_logs($per_page = 50, $current_page = 0, $count = false)
-    {
-        EE_Registry::instance()->load_model('Change_Log');
-        // we may need to do multiple queries (joining differently), so we actually want an array of query params
-        $query_params = array(array('LOG_type' => EEM_Change_Log::type_gateway));
-        // check if they've selected a specific payment method
-        if (isset($this->_req_data['_payment_method']) && $this->_req_data['_payment_method'] !== 'all') {
-            $query_params[0]['OR*pm_or_pay_pm'] = array(
-                'Payment.Payment_Method.PMD_ID' => $this->_req_data['_payment_method'],
-                'Payment_Method.PMD_ID'         => $this->_req_data['_payment_method'],
-            );
-        }
-        // take into account search
-        if (isset($this->_req_data['s']) && $this->_req_data['s']) {
-            $similarity_string = array('LIKE', '%' . str_replace("", "%", $this->_req_data['s']) . '%');
-            $query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_fname'] = $similarity_string;
-            $query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_lname'] = $similarity_string;
-            $query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_email'] = $similarity_string;
-            $query_params[0]['OR*s']['Payment.Payment_Method.PMD_name'] = $similarity_string;
-            $query_params[0]['OR*s']['Payment.Payment_Method.PMD_admin_name'] = $similarity_string;
-            $query_params[0]['OR*s']['Payment.Payment_Method.PMD_type'] = $similarity_string;
-            $query_params[0]['OR*s']['LOG_message'] = $similarity_string;
-            $query_params[0]['OR*s']['Payment_Method.PMD_name'] = $similarity_string;
-            $query_params[0]['OR*s']['Payment_Method.PMD_admin_name'] = $similarity_string;
-            $query_params[0]['OR*s']['Payment_Method.PMD_type'] = $similarity_string;
-            $query_params[0]['OR*s']['LOG_message'] = $similarity_string;
-        }
-        if (
-            isset($this->_req_data['payment-filter-start-date'])
-            && isset($this->_req_data['payment-filter-end-date'])
-        ) {
-            // add date
-            $start_date = wp_strip_all_tags($this->_req_data['payment-filter-start-date']);
-            $end_date = wp_strip_all_tags($this->_req_data['payment-filter-end-date']);
-            // make sure our timestamps start and end right at the boundaries for each day
-            $start_date = date('Y-m-d', strtotime($start_date)) . ' 00:00:00';
-            $end_date = date('Y-m-d', strtotime($end_date)) . ' 23:59:59';
-            // convert to timestamps
-            $start_date = strtotime($start_date);
-            $end_date = strtotime($end_date);
-            // makes sure start date is the lowest value and vice versa
-            $start_date = min($start_date, $end_date);
-            $end_date = max($start_date, $end_date);
-            // convert for query
-            $start_date = EEM_Change_Log::instance()->convert_datetime_for_query(
-                'LOG_time',
-                date('Y-m-d H:i:s', $start_date),
-                'Y-m-d H:i:s'
-            );
-            $end_date   = EEM_Change_Log::instance()->convert_datetime_for_query(
-                'LOG_time',
-                date('Y-m-d H:i:s', $end_date),
-                'Y-m-d H:i:s'
-            );
-            $query_params[0]['LOG_time'] = array('BETWEEN', array($start_date, $end_date));
-        }
-        if ($count) {
-            return EEM_Change_Log::instance()->count($query_params);
-        }
-        if (isset($this->_req_data['order'])) {
-            $sort = (isset($this->_req_data['order']) && ! empty($this->_req_data['order']))
-                ? $this->_req_data['order']
-                : 'DESC';
-            $query_params['order_by'] = array('LOG_time' => $sort);
-        } else {
-            $query_params['order_by'] = array('LOG_time' => 'DESC');
-        }
-        $offset = ($current_page - 1) * $per_page;
-        if (! isset($this->_req_data['download_results'])) {
-            $query_params['limit'] = array($offset, $per_page);
-        }
-        // now they've requested to instead just download the file instead of viewing it.
-        if (isset($this->_req_data['download_results'])) {
-            $wpdb_results = EEM_Change_Log::instance()->get_all_efficiently($query_params);
-            header('Content-Disposition: attachment');
-            header("Content-Disposition: attachment; filename=ee_payment_logs_for_" . sanitize_key(site_url()));
-            echo '<h1> '
-                . sprintf(
-                    esc_html__('Payment Logs for %1$s', 'event_espresso'),
-                    esc_url_raw(site_url())
-                )
-                . '</h1 >';
-            echo '<h3>' . esc_html__('Query:', 'event_espresso') . '</h3>';
-            echo esc_html(var_export($query_params, true));
-            echo '<h3>' . esc_html__('Results:', 'event_espresso') . '</h3>';
-            echo esc_html(var_export($wpdb_results, true));
-            die;
-        }
-        return EEM_Change_Log::instance()->get_all($query_params);
-    }
-
-
-    /**
-     * Used by usort to RE-sort log query results, because we lose the ordering
-     * because we're possibly combining the results from two queries
-     *
-     * @param EE_Change_Log $logA
-     * @param EE_Change_Log $logB
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _sort_logs_again($logA, $logB)
-    {
-        $timeA = $logA->get_raw('LOG_time');
-        $timeB = $logB->get_raw('LOG_time');
-        if ($timeA == $timeB) {
-            return 0;
-        }
-        $comparison = $timeA < $timeB ? -1 : 1;
-        if (strtoupper($this->_sort_logs_again_direction) == 'DESC') {
-            return $comparison * -1;
-        }
-        return $comparison;
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _payment_log_details()
-    {
-        EE_Registry::instance()->load_model('Change_Log');
-        /** @var $payment_log EE_Change_Log */
-        $payment_log = EEM_Change_Log::instance()->get_one_by_ID($this->_req_data['ID']);
-        $payment_method = null;
-        $transaction = null;
-        if ($payment_log instanceof EE_Change_Log) {
-            if ($payment_log->object() instanceof EE_Payment) {
-                $payment_method = $payment_log->object()->payment_method();
-                $transaction = $payment_log->object()->transaction();
-            } elseif ($payment_log->object() instanceof EE_Payment_Method) {
-                $payment_method = $payment_log->object();
-            } elseif ($payment_log->object() instanceof EE_Transaction) {
-                $transaction = $payment_log->object();
-                $payment_method = $transaction->payment_method();
-            }
-        }
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            EE_PAYMENTS_TEMPLATE_PATH . 'payment_log_details.template.php',
-            array(
-                'payment_log'    => $payment_log,
-                'payment_method' => $payment_method,
-                'transaction'    => $transaction,
-            ),
-            true
-        );
-        $this->display_admin_page_with_no_sidebar();
-    }
+	/**
+	 * Variables used for when we're re-sorting the logs results,
+	 * in case we needed to do two queries, and we need to resort
+	 *
+	 * @var string
+	 */
+	private $_sort_logs_again_direction;
+
+
+	/**
+	 * @Constructor
+	 * @access public
+	 * @param bool $routing indicate whether we want to just load the object and handle routing or just load the object.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function __construct($routing = true)
+	{
+		parent::__construct($routing);
+	}
+
+
+	protected function _init_page_props()
+	{
+		$this->page_slug = EE_PAYMENTS_PG_SLUG;
+		$this->page_label = esc_html__('Payment Methods', 'event_espresso');
+		$this->_admin_base_url = EE_PAYMENTS_ADMIN_URL;
+		$this->_admin_base_path = EE_PAYMENTS_ADMIN;
+	}
+
+
+	protected function _ajax_hooks()
+	{
+		// todo: all hooks for ajax goes here.
+	}
+
+
+	protected function _define_page_props()
+	{
+		$this->_admin_page_title = $this->page_label;
+		$this->_labels = array(
+			'publishbox' => esc_html__('Update Settings', 'event_espresso'),
+		);
+	}
+
+
+	protected function _set_page_routes()
+	{
+		/**
+		 * note that with payment method capabilities, although we've implemented
+		 * capability mapping which will be used for accessing payment methods owned by
+		 * other users.  This is not fully implemented yet in the payment method ui.
+		 * Currently, only the "plural" caps are in active use.
+		 * When cap mapping is implemented, some routes will need to use the singular form of
+		 * capability method and also include the $id of the payment method for the route.
+		 **/
+		$this->_page_routes = array(
+			'default'                   => array(
+				'func'       => '_payment_methods_list',
+				'capability' => 'ee_edit_payment_methods',
+			),
+			'payment_settings'          => array(
+				'func'       => '_payment_settings',
+				'capability' => 'ee_manage_gateways',
+			),
+			'activate_payment_method'   => array(
+				'func'       => '_activate_payment_method',
+				'noheader'   => true,
+				'capability' => 'ee_edit_payment_methods',
+			),
+			'deactivate_payment_method' => array(
+				'func'       => '_deactivate_payment_method',
+				'noheader'   => true,
+				'capability' => 'ee_delete_payment_methods',
+			),
+			'update_payment_method'     => array(
+				'func'               => '_update_payment_method',
+				'noheader'           => true,
+				'headers_sent_route' => 'default',
+				'capability'         => 'ee_edit_payment_methods',
+			),
+			'update_payment_settings'   => array(
+				'func'       => '_update_payment_settings',
+				'noheader'   => true,
+				'capability' => 'ee_manage_gateways',
+			),
+			'payment_log'               => array(
+				'func'       => '_payment_log_overview_list_table',
+				'capability' => 'ee_read_payment_methods',
+			),
+			'payment_log_details'       => array(
+				'func'       => '_payment_log_details',
+				'capability' => 'ee_read_payment_methods',
+			),
+		);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _set_page_config()
+	{
+		$payment_method_list_config = array(
+			'nav'           => array(
+				'label' => esc_html__('Payment Methods', 'event_espresso'),
+				'icon' => 'dashicons-bank',
+				'order' => 10,
+			),
+			'metaboxes'     => $this->_default_espresso_metaboxes,
+			'help_tabs'     => array_merge(
+				array(
+					'payment_methods_overview_help_tab' => array(
+						'title'    => esc_html__('Payment Methods Overview', 'event_espresso'),
+						'filename' => 'payment_methods_overview',
+					),
+				),
+				$this->_add_payment_method_help_tabs()
+			),
+			'require_nonce' => false,
+		);
+		$this->_page_config = array(
+			'default'          => $payment_method_list_config,
+			'payment_settings' => array(
+				'nav'           => array(
+					'label' => esc_html__('Settings', 'event_espresso'),
+					'icon' => 'dashicons-admin-generic',
+					'order' => 20,
+				),
+				'help_tabs'     => array(
+					'payment_methods_settings_help_tab' => array(
+						'title'    => esc_html__('Payment Method Settings', 'event_espresso'),
+						'filename' => 'payment_methods_settings',
+					),
+				),
+				'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
+				'require_nonce' => false,
+			),
+			'payment_log'      => array(
+				'nav'           => array(
+					'label' => esc_html__("Logs", 'event_espresso'),
+					'icon' => 'dashicons-text-page',
+					'order' => 30,
+				),
+				'list_table'    => 'Payment_Log_Admin_List_Table',
+				'metaboxes'     => $this->_default_espresso_metaboxes,
+				'require_nonce' => false,
+			),
+		);
+	}
+
+
+	/**
+	 * @return array
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _add_payment_method_help_tabs()
+	{
+		EE_Registry::instance()->load_lib('Payment_Method_Manager');
+		$payment_method_types = EE_Payment_Method_Manager::instance()->payment_method_types();
+		$all_pmt_help_tabs_config = array();
+		foreach ($payment_method_types as $payment_method_type) {
+			if (
+				! EE_Registry::instance()->CAP->current_user_can(
+					$payment_method_type->cap_name(),
+					'specific_payment_method_type_access'
+				)
+			) {
+				continue;
+			}
+			foreach ($payment_method_type->help_tabs_config() as $help_tab_name => $config) {
+				$template_args = isset($config['template_args']) ? $config['template_args'] : array();
+				$template_args['admin_page_obj'] = $this;
+				$all_pmt_help_tabs_config[ $help_tab_name ] = array(
+					'title'   => $config['title'],
+					'content' => EEH_Template::display_template(
+						$payment_method_type->file_folder() . 'help_tabs/' . $config['filename'] . '.help_tab.php',
+						$template_args,
+						true
+					),
+				);
+			}
+		}
+		return $all_pmt_help_tabs_config;
+	}
+
+
+	// none of the below group are currently used for Gateway Settings
+	protected function _add_screen_options()
+	{
+	}
+
+
+	protected function _add_feature_pointers()
+	{
+	}
+
+
+	public function admin_init()
+	{
+	}
+
+
+	public function admin_notices()
+	{
+	}
+
+
+	public function admin_footer_scripts()
+	{
+	}
+
+
+	public function load_scripts_styles()
+	{
+		// styles
+		wp_enqueue_style('espresso-ui-theme');
+		wp_register_style(
+			'espresso_payments',
+			EE_PAYMENTS_ASSETS_URL . 'ee-payments.css',
+			[],
+			EVENT_ESPRESSO_VERSION
+		);
+		// scripts
+		wp_enqueue_script('ee_admin_js');
+		wp_enqueue_script('ee-text-links');
+		wp_enqueue_script(
+			'espresso_payments',
+			EE_PAYMENTS_ASSETS_URL . 'espresso_payments_admin.js',
+			['ee-datepicker'],
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+	}
+
+
+	public function load_scripts_styles_default()
+	{
+		wp_enqueue_style('espresso_payments');
+		wp_enqueue_style('ee-text-links');
+	}
+
+
+	public function load_scripts_styles_payment_log_details()
+	{
+		wp_enqueue_style('espresso_payments');
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _payment_methods_list()
+	{
+		/**
+		 * first let's ensure payment methods have been set up.
+		 * We do this here because when people activate a payment method for the first time (as an addon),
+		 * it may not set up its capabilities or get registered correctly due to the loading process.
+		 * However, people MUST set up the details for the payment method,
+		 * so it's safe to do a recheck here.
+		 */
+		EE_Registry::instance()->load_lib('Payment_Method_Manager');
+		EEM_Payment_Method::instance()->verify_button_urls();
+		// set up tabs, one for each payment method type
+		$tabs = array();
+		$payment_methods = array();
+		foreach (EE_Payment_Method_Manager::instance()->payment_method_types() as $pmt_obj) {
+			// we don't want to show admin-only PMTs for now
+			if ($pmt_obj instanceof EE_PMT_Admin_Only) {
+				continue;
+			}
+			// check access
+			if (
+				! EE_Registry::instance()->CAP->current_user_can(
+					$pmt_obj->cap_name(),
+					'specific_payment_method_type_access'
+				)
+			) {
+				continue;
+			}
+			// check for any active pms of that type
+			$payment_method = EEM_Payment_Method::instance()->get_one_of_type($pmt_obj->system_name());
+			if (! $payment_method instanceof EE_Payment_Method) {
+				$payment_method = EE_Payment_Method::new_instance(
+					array(
+						'PMD_slug'       => sanitize_key($pmt_obj->system_name()),
+						'PMD_type'       => $pmt_obj->system_name(),
+						'PMD_name'       => $pmt_obj->pretty_name(),
+						'PMD_admin_name' => $pmt_obj->pretty_name(),
+					)
+				);
+			}
+			$payment_methods[ $payment_method->slug() ] = $payment_method;
+		}
+		$payment_methods = apply_filters(
+			'FHEE__Payments_Admin_Page___payment_methods_list__payment_methods',
+			$payment_methods
+		);
+		foreach ($payment_methods as $payment_method) {
+			if ($payment_method instanceof EE_Payment_Method) {
+				$this->addMetaBox(
+					// html id
+					'espresso_' . $payment_method->slug() . '_payment_settings',
+					// title
+					sprintf(esc_html__('%s Settings', 'event_espresso'), $payment_method->admin_name()),
+					// callback
+					array($this, 'payment_method_settings_meta_box'),
+					// post type
+					null,
+					// context
+					'normal',
+					// priority
+					'default',
+					// callback args
+					array('payment_method' => $payment_method)
+				);
+				// setup for tabbed content
+				$tabs[ $payment_method->slug() ] = array(
+					'label' => $payment_method->admin_name(),
+					'class' => $payment_method->active() ? 'gateway-active' : '',
+					'href'  => 'espresso_' . $payment_method->slug() . '_payment_settings',
+					'title' => esc_html__('Modify this Payment Method', 'event_espresso'),
+					'slug'  => $payment_method->slug(),
+					'icon'  => $payment_method->active()
+						? '<span class="dashicons dashicons-yes-alt"></span>'
+						: '<span class="dashicons dashicons-remove"></span>',
+				);
+			}
+		}
+		$this->_template_args['admin_page_header'] = EEH_Tabbed_Content::tab_text_links(
+			$tabs,
+			'payment_method_links',
+			'',
+			$this->_get_active_payment_method_slug()
+		);
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 *   _get_active_payment_method_slug
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function _get_active_payment_method_slug()
+	{
+		$payment_method_slug = false;
+		// decide which payment method tab to open first, as dictated by the request's 'payment_method'
+		if (isset($this->_req_data['payment_method'])) {
+			// if they provided the current payment method, use it
+			$payment_method_slug = sanitize_key($this->_req_data['payment_method']);
+		}
+		/** @var EE_Payment_Method $payment_method */
+		$payment_method = EEM_Payment_Method::instance()->get_one(array(array('PMD_slug' => $payment_method_slug)));
+		// if that didn't work or wasn't provided, find another way to select the current pm
+		if (! $this->_verify_payment_method($payment_method)) {
+			// like, looking for an active one
+			$payment_method = EEM_Payment_Method::instance()->get_one_active('CART');
+			// test that one as well
+			if ($this->_verify_payment_method($payment_method)) {
+				$payment_method_slug = $payment_method->slug();
+			} else {
+				$payment_method_slug = 'paypal_standard';
+			}
+		}
+		return $payment_method_slug;
+	}
+
+
+	/**
+	 *    payment_method_settings_meta_box
+	 *    returns TRUE if the passed payment method is properly constructed and the logged-in user has the correct
+	 *    capabilities to access it
+	 *
+	 * @param EE_Payment_Method $payment_method
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	protected function _verify_payment_method($payment_method)
+	{
+		if (
+			$payment_method instanceof EE_Payment_Method && $payment_method->type_obj() instanceof EE_PMT_Base
+			&& EE_Registry::instance()->CAP->current_user_can(
+				$payment_method->type_obj()->cap_name(),
+				'specific_payment_method_type_access'
+			)
+		) {
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 *    payment_method_settings_meta_box
+	 *
+	 * @param NULL  $post_obj_which_is_null is an object containing the current post (as a $post object)
+	 * @param array $metabox                is an array with metabox id, title, callback, and args elements. the value
+	 *                                      at 'args' has key 'payment_method', as set within _payment_methods_list
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function payment_method_settings_meta_box($post_obj_which_is_null, $metabox)
+	{
+		$payment_method = isset($metabox['args'], $metabox['args']['payment_method'])
+			? $metabox['args']['payment_method'] : null;
+		if (! $payment_method instanceof EE_Payment_Method) {
+			throw new EE_Error(
+				esc_html__(
+					'Payment method metabox setup incorrectly. No Payment method object was supplied',
+					'event_espresso'
+				)
+			);
+		}
+		$payment_method_scopes = $payment_method->active();
+		// if the payment method really exists show its form, otherwise the activation template
+		if ($payment_method->ID() && ! empty($payment_method_scopes)) {
+			$form = $this->_generate_payment_method_settings_form($payment_method);
+			if ($form->form_data_present_in($this->_req_data)) {
+				$form->receive_form_submission($this->_req_data);
+			}
+			echo wp_kses($form->form_open() . $form->get_html_and_js() . $form->form_close(), AllowedTags::getWithFormTags());
+		} else {
+			echo wp_kses($this->_activate_payment_method_button($payment_method)->get_html_and_js(), AllowedTags::getWithFormTags());
+		}
+	}
+
+
+	/**
+	 * Gets the form for all the settings related to this payment method type
+	 *
+	 * @access protected
+	 * @param EE_Payment_Method $payment_method
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 */
+	protected function _generate_payment_method_settings_form(EE_Payment_Method $payment_method = null)
+	{
+		if (! $payment_method instanceof EE_Payment_Method) {
+			return new EE_Form_Section_Proper();
+		}
+		return new EE_Form_Section_Proper(
+			array(
+				'name'            => $payment_method->slug() . '_settings_form',
+				'html_id'         => $payment_method->slug() . '_settings_form',
+				'action'          => EE_Admin_Page::add_query_args_and_nonce(
+					array(
+						'action'         => 'update_payment_method',
+						'payment_method' => $payment_method->slug(),
+					),
+					EE_PAYMENTS_ADMIN_URL
+				),
+				'layout_strategy' => new EE_Admin_Two_Column_Layout(),
+				'subsections'     => apply_filters(
+					'FHEE__Payments_Admin_Page___generate_payment_method_settings_form__form_subsections',
+					array(
+						'pci_dss_compliance'      => $this->_pci_dss_compliance($payment_method),
+						'currency_support'        => $this->_currency_support($payment_method),
+						'payment_method_settings' => $this->_payment_method_settings($payment_method),
+						'update'                  => $this->_update_payment_method_button($payment_method),
+						'deactivate'              => $this->_deactivate_payment_method_button($payment_method),
+						'fine_print'              => $this->_fine_print(),
+					),
+					$payment_method
+				),
+			)
+		);
+	}
+
+
+	/**
+	 * _pci_dss_compliance
+	 *
+	 * @access protected
+	 * @param EE_Payment_Method $payment_method
+	 * @return EE_Form_Section_HTML
+	 * @throws EE_Error
+	 */
+	protected function _pci_dss_compliance(EE_Payment_Method $payment_method)
+	{
+		if ($payment_method->type_obj()->requires_https()) {
+			return new EE_Form_Section_HTML(
+				EEH_HTML::table(
+					EEH_HTML::tr(
+						EEH_HTML::th(
+							EEH_HTML::label(
+								EEH_HTML::strong(
+									esc_html__('IMPORTANT', 'event_espresso'),
+									'',
+									'important-notice'
+								)
+							)
+						) .
+						EEH_HTML::td(
+							EEH_HTML::strong(
+								esc_html__(
+									'You are responsible for your own website security and Payment Card Industry Data Security Standards (PCI DSS) compliance.',
+									'event_espresso'
+								)
+							)
+							.
+							EEH_HTML::br()
+							.
+							esc_html__('Learn more about ', 'event_espresso')
+							. EEH_HTML::link(
+								'https://www.pcisecuritystandards.org/merchants/index.php',
+								esc_html__('PCI DSS compliance', 'event_espresso')
+							)
+						)
+					)
+				)
+			);
+		}
+		return new EE_Form_Section_HTML('');
+	}
+
+
+	/**
+	 * _currency_support
+	 *
+	 * @access protected
+	 * @param EE_Payment_Method $payment_method
+	 * @return EE_Form_Section_HTML
+	 * @throws EE_Error
+	 */
+	protected function _currency_support(EE_Payment_Method $payment_method)
+	{
+		if (! $payment_method->usable_for_currency(EE_Config::instance()->currency->code)) {
+			return new EE_Form_Section_HTML(
+				EEH_HTML::table(
+					EEH_HTML::tr(
+						EEH_HTML::th(
+							EEH_HTML::label(
+								EEH_HTML::strong(
+									esc_html__('IMPORTANT', 'event_espresso'),
+									'',
+									'important-notice'
+								)
+							)
+						) .
+						EEH_HTML::td(
+							EEH_HTML::strong(
+								sprintf(
+									esc_html__(
+										'This payment method does not support the currency set on your site (%1$s). Please activate a different payment method or change your site\'s country and associated currency.',
+										'event_espresso'
+									),
+									EE_Config::instance()->currency->code
+								)
+							)
+						)
+					)
+				)
+			);
+		}
+		return new EE_Form_Section_HTML('');
+	}
+
+
+	/**
+	 * _update_payment_method_button
+	 *
+	 * @access protected
+	 * @param EE_Payment_Method $payment_method
+	 * @return EE_Payment_Method_Form
+	 * @throws EE_Error
+	 */
+	protected function _payment_method_settings(EE_Payment_Method $payment_method)
+	{
+		// modify the form, so we only have/show fields that will be implemented for this version
+		return $this->_simplify_form($payment_method->type_obj()->settings_form(), $payment_method->name());
+	}
+
+
+	/**
+	 * Simplifies the form to merely reproduce 4.1's gateway settings functionality
+	 *
+	 * @param EE_Form_Section_Proper $form_section
+	 * @param string                 $payment_method_name
+	 * @return EE_Payment_Method_Form
+	 * @throws EE_Error
+	 */
+	protected function _simplify_form($form_section, $payment_method_name = '')
+	{
+		if ($form_section instanceof EE_Payment_Method_Form) {
+			$form_section->exclude(
+				array(
+					'PMD_type', // don't want them changing the type
+					'PMD_slug', // or the slug (probably never)
+					'PMD_wp_user', // or the user's ID
+					'Currency' // or the currency, until the rest of EE supports simultaneous currencies
+				)
+			);
+			return $form_section;
+		} else {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'The EE_Payment_Method_Form for the "%1$s" payment method is missing or invalid.',
+						'event_espresso'
+					),
+					$payment_method_name
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * _update_payment_method_button
+	 *
+	 * @access protected
+	 * @param EE_Payment_Method $payment_method
+	 * @return EE_Form_Section_HTML
+	 * @throws EE_Error
+	 */
+	protected function _update_payment_method_button(EE_Payment_Method $payment_method)
+	{
+		$update_button = new EE_Submit_Input(
+			array(
+				'name'       => 'submit',
+				'html_id'    => 'save_' . $payment_method->slug() . '_settings',
+				'default'    => sprintf(
+					esc_html__('Update %s Payment Settings', 'event_espresso'),
+					$payment_method->admin_name()
+				),
+				'html_label' => EEH_HTML::nbsp(),
+			)
+		);
+		return new EE_Form_Section_HTML(
+			EEH_HTML::table(
+				EEH_HTML::no_row(EEH_HTML::br(2)) .
+				EEH_HTML::tr(
+					EEH_HTML::th(esc_html__('Update Settings', 'event_espresso')) .
+					EEH_HTML::td(
+						$update_button->get_html_for_input()
+					)
+				)
+			)
+		);
+	}
+
+
+	/**
+	 * _deactivate_payment_method_button
+	 *
+	 * @access protected
+	 * @param EE_Payment_Method $payment_method
+	 * @return EE_Form_Section_HTML
+	 */
+	protected function _deactivate_payment_method_button(EE_Payment_Method $payment_method)
+	{
+		$link_text_and_title = sprintf(
+			esc_html__('Deactivate %1$s Payments?', 'event_espresso'),
+			$payment_method->admin_name()
+		);
+		return new EE_Form_Section_HTML(
+			EEH_HTML::table(
+				EEH_HTML::tr(
+					EEH_HTML::th(esc_html__('Deactivate Payment Method', 'event_espresso')) .
+					EEH_HTML::td(
+						EEH_HTML::link(
+							EE_Admin_Page::add_query_args_and_nonce(
+								array(
+									'action'         => 'deactivate_payment_method',
+									'payment_method' => $payment_method->slug(),
+								),
+								EE_PAYMENTS_ADMIN_URL
+							),
+							$link_text_and_title,
+							$link_text_and_title,
+							'deactivate_' . $payment_method->slug(),
+							'button button--secondary'
+						)
+					)
+				)
+			)
+		);
+	}
+
+
+	/**
+	 * _activate_payment_method_button
+	 *
+	 * @access protected
+	 * @param EE_Payment_Method $payment_method
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 */
+	protected function _activate_payment_method_button(EE_Payment_Method $payment_method)
+	{
+		$link_text_and_title = sprintf(
+			esc_html__('Activate %1$s Payment Method?', 'event_espresso'),
+			$payment_method->admin_name()
+		);
+		return new EE_Form_Section_Proper(
+			array(
+				'name'            => 'activate_' . $payment_method->slug() . '_settings_form',
+				'html_id'         => 'activate_' . $payment_method->slug() . '_settings_form',
+				'action'          => '#',
+				'layout_strategy' => new EE_Admin_Two_Column_Layout(),
+				'subsections'     => apply_filters(
+					'FHEE__Payments_Admin_Page___activate_payment_method_button__form_subsections',
+					array(
+						new EE_Form_Section_HTML(
+							EEH_HTML::table(
+								EEH_HTML::tr(
+									EEH_HTML::td(
+										$payment_method->type_obj()->introductory_html(),
+										'',
+										'',
+										'',
+										'colspan="2"'
+									)
+								) .
+								EEH_HTML::tr(
+									EEH_HTML::th(
+										EEH_HTML::label(esc_html__('Click to Activate ', 'event_espresso'))
+									) .
+									EEH_HTML::td(
+										EEH_HTML::link(
+											EE_Admin_Page::add_query_args_and_nonce(
+												array(
+													'action'              => 'activate_payment_method',
+													'payment_method_type' => $payment_method->type(),
+												),
+												EE_PAYMENTS_ADMIN_URL
+											),
+											$link_text_and_title,
+											$link_text_and_title,
+											'activate_' . $payment_method->slug(),
+											'button button--primary-alt'
+										)
+									)
+								)
+							)
+						),
+					),
+					$payment_method
+				),
+			)
+		);
+	}
+
+
+	/**
+	 * _fine_print
+	 *
+	 * @access protected
+	 * @return EE_Form_Section_HTML
+	 */
+	protected function _fine_print()
+	{
+		return new EE_Form_Section_HTML(
+			EEH_HTML::table(
+				EEH_HTML::tr(
+					EEH_HTML::th() .
+					EEH_HTML::td(
+						EEH_HTML::p(esc_html__('All fields marked with a * are required fields', 'event_espresso'), '', 'grey-text')
+					)
+				)
+			)
+		);
+	}
+
+
+	/**
+	 * Activates a payment method of that type. Mostly assuming there is only 1 of that type (or none so far)
+	 *
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @global WP_User $current_user
+	 */
+	protected function _activate_payment_method()
+	{
+		if (isset($this->_req_data['payment_method_type'])) {
+			$payment_method_type = sanitize_text_field($this->_req_data['payment_method_type']);
+			// see if one exists
+			EE_Registry::instance()->load_lib('Payment_Method_Manager');
+			$payment_method = EE_Payment_Method_Manager::instance()
+													   ->activate_a_payment_method_of_type($payment_method_type);
+			$this->_redirect_after_action(
+				1,
+				'Payment Method',
+				'activated',
+				array('action' => 'default', 'payment_method' => $payment_method->slug())
+			);
+		} else {
+			$this->_redirect_after_action(false, 'Payment Method', 'activated', array('action' => 'default'));
+		}
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _deactivate_payment_method()
+	{
+		if (isset($this->_req_data['payment_method'])) {
+			$payment_method_slug = sanitize_key($this->_req_data['payment_method']);
+			// deactivate it
+			EE_Registry::instance()->load_lib('Payment_Method_Manager');
+			$count_updated = EE_Payment_Method_Manager::instance()->deactivate_payment_method($payment_method_slug);
+			$this->_redirect_after_action(
+				$count_updated,
+				'Payment Method',
+				'deactivated',
+				array('action' => 'default', 'payment_method' => $payment_method_slug)
+			);
+		} else {
+			$this->_redirect_after_action(false, 'Payment Method', 'deactivated', array('action' => 'default'));
+		}
+	}
+
+
+	/**
+	 * Processes the payment method form that was submitted. This is slightly trickier than usual form
+	 * processing because we first need to identify WHICH form was processed and which payment method
+	 * it corresponds to. Once we have done that, we see if the form is valid. If it is, the
+	 * form's data is saved, and we redirect to the default payment methods page, setting the updated payment method
+	 * as the currently-selected one. If it DOESN'T validate, we render the page with the form's errors (in the
+	 * subsequently called 'headers_sent_func' which is _payment_methods_list)
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _update_payment_method()
+	{
+		if ($_SERVER['REQUEST_METHOD'] == 'POST') {
+			// ok let's find which gateway form to use based on the form input
+			EE_Registry::instance()->load_lib('Payment_Method_Manager');
+			/** @var $correct_pmt_form_to_use EE_Payment_Method_Form */
+			$correct_pmt_form_to_use = null;
+			$payment_method = null;
+			foreach (EEM_Payment_Method::instance()->get_all() as $payment_method) {
+				if ($payment_method instanceof EE_Payment_Method) {
+					// get the form and simplify it, like what we do when we display it
+					$pmt_form = $this->_generate_payment_method_settings_form($payment_method);
+					if ($pmt_form->form_data_present_in($this->_req_data)) {
+						$correct_pmt_form_to_use = $pmt_form;
+						break;
+					}
+				}
+			}
+			// if we couldn't find the correct payment method type...
+			if (! $correct_pmt_form_to_use) {
+				EE_Error::add_error(
+					esc_html__(
+						"We could not find which payment method type your form submission related to. Please contact support",
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				$this->_redirect_after_action(false, 'Payment Method', 'activated', array('action' => 'default'));
+			}
+			$correct_pmt_form_to_use->receive_form_submission($this->_req_data);
+			if ($correct_pmt_form_to_use->is_valid()) {
+				$payment_settings_subform = $correct_pmt_form_to_use->get_subsection('payment_method_settings');
+				if (! $payment_settings_subform instanceof EE_Payment_Method_Form) {
+					throw new EE_Error(
+						sprintf(
+							esc_html__(
+								'The payment method could not be saved because the form sections were misnamed. We expected to find %1$s, but did not.',
+								'event_espresso'
+							),
+							'payment_method_settings'
+						)
+					);
+				}
+				$payment_settings_subform->save();
+				/** @var $pm EE_Payment_Method */
+				$this->_redirect_after_action(
+					true,
+					'Payment Method',
+					'updated',
+					array('action' => 'default', 'payment_method' => $payment_method->slug())
+				);
+			} else {
+				EE_Error::add_error(
+					sprintf(
+						esc_html__(
+							'Payment method of type %s was not saved because there were validation errors. They have been marked in the form',
+							'event_espresso'
+						),
+						$payment_method instanceof EE_Payment_Method ? $payment_method->type_obj()->pretty_name()
+							: esc_html__('"(unknown)"', 'event_espresso')
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		}
+	}
+
+
+	/**
+	 * Displays payment settings (not payment METHOD settings, that's _payment_method_settings)
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _payment_settings()
+	{
+		$form = $this->getPaymentSettingsForm();
+		$this->_set_add_edit_form_tags('update_payment_settings');
+		$this->_set_publish_post_box_vars(null, false, false, null, false);
+		$this->_template_args['admin_page_content'] = EEH_HTML::div(
+			$form->get_html_and_js(),
+			'',
+			'padding'
+		);
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 *        _update_payment_settings
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _update_payment_settings()
+	{
+		$form = $this->getPaymentSettingsForm();
+		if ($form->was_submitted($this->_req_data)) {
+			$form->receive_form_submission($this->_req_data);
+			if ($form->is_valid()) {
+				/**
+				 * @var $reg_config EE_Registration_Config
+				 */
+				$loader = LoaderFactory::getLoader();
+				$reg_config = $loader->getShared('EE_Registration_Config');
+				$valid_data = $form->valid_data();
+				$reg_config->show_pending_payment_options = $valid_data['show_pending_payment_options'];
+				$reg_config->gateway_log_lifespan = $valid_data['gateway_log_lifespan'];
+			}
+		}
+		EE_Registry::instance()->CFG = apply_filters(
+			'FHEE__Payments_Admin_Page___update_payment_settings__CFG',
+			EE_Registry::instance()->CFG
+		);
+
+		$what = esc_html__('Payment Settings', 'event_espresso');
+		$success = $this->_update_espresso_configuration(
+			$what,
+			EE_Registry::instance()->CFG,
+			__FILE__,
+			__FUNCTION__,
+			__LINE__
+		);
+		$this->_redirect_after_action(
+			$success,
+			$what,
+			esc_html__('updated', 'event_espresso'),
+			array('action' => 'payment_settings')
+		);
+	}
+
+
+	/**
+	 * Gets the form used for updating payment settings
+	 *
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function getPaymentSettingsForm()
+	{
+		/**
+		 * @var $reg_config EE_Registration_Config
+		 */
+		$reg_config = LoaderFactory::getLoader()->getShared('EE_Registration_Config');
+		return new EE_Form_Section_Proper(
+			array(
+				'name' => 'payment-settings',
+				'layout_strategy' => new EE_Admin_Two_Column_Layout(),
+				'subsections' => array(
+					'show_pending_payment_options' => new EE_Yes_No_Input(
+						array(
+							'html_name' => 'show_pending_payment_options',
+							'default' => $reg_config->show_pending_payment_options,
+							'html_help_text' => esc_html__(
+								"If a payment is marked as 'Pending Payment', or if payment is deferred (ie, an offline gateway like Check, Bank, or Invoice is used), then give registrants the option to retry payment. ",
+								'event_espresso'
+							)
+						)
+					),
+					'gateway_log_lifespan' => new EE_Select_Input(
+						$reg_config->gatewayLogLifespanOptions(),
+						array(
+							'html_label_text' => esc_html__('Gateway Logs Lifespan', 'event_espresso'),
+							'html_help_text' => esc_html__('If issues arise with payments being made through a payment gateway, it\'s helpful to log non-sensitive communications with the payment gateway. But it\'s a security responsibility, so it\'s a good idea to not keep them for any longer than necessary.', 'event_espresso'),
+							'default' => $reg_config->gateway_log_lifespan,
+						)
+					)
+				)
+			)
+		);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	protected function _payment_log_overview_list_table()
+	{
+		$this->display_admin_list_table_page_with_sidebar();
+	}
+
+
+	protected function _set_list_table_views_payment_log()
+	{
+		$this->_views = array(
+			'all' => array(
+				'slug'  => 'all',
+				'label' => esc_html__('View All Logs', 'event_espresso'),
+				'count' => 0,
+			),
+		);
+	}
+
+
+	/**
+	 * @param int  $per_page
+	 * @param int  $current_page
+	 * @param bool $count
+	 * @return array|int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_payment_logs($per_page = 50, $current_page = 0, $count = false)
+	{
+		EE_Registry::instance()->load_model('Change_Log');
+		// we may need to do multiple queries (joining differently), so we actually want an array of query params
+		$query_params = array(array('LOG_type' => EEM_Change_Log::type_gateway));
+		// check if they've selected a specific payment method
+		if (isset($this->_req_data['_payment_method']) && $this->_req_data['_payment_method'] !== 'all') {
+			$query_params[0]['OR*pm_or_pay_pm'] = array(
+				'Payment.Payment_Method.PMD_ID' => $this->_req_data['_payment_method'],
+				'Payment_Method.PMD_ID'         => $this->_req_data['_payment_method'],
+			);
+		}
+		// take into account search
+		if (isset($this->_req_data['s']) && $this->_req_data['s']) {
+			$similarity_string = array('LIKE', '%' . str_replace("", "%", $this->_req_data['s']) . '%');
+			$query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_fname'] = $similarity_string;
+			$query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_lname'] = $similarity_string;
+			$query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_email'] = $similarity_string;
+			$query_params[0]['OR*s']['Payment.Payment_Method.PMD_name'] = $similarity_string;
+			$query_params[0]['OR*s']['Payment.Payment_Method.PMD_admin_name'] = $similarity_string;
+			$query_params[0]['OR*s']['Payment.Payment_Method.PMD_type'] = $similarity_string;
+			$query_params[0]['OR*s']['LOG_message'] = $similarity_string;
+			$query_params[0]['OR*s']['Payment_Method.PMD_name'] = $similarity_string;
+			$query_params[0]['OR*s']['Payment_Method.PMD_admin_name'] = $similarity_string;
+			$query_params[0]['OR*s']['Payment_Method.PMD_type'] = $similarity_string;
+			$query_params[0]['OR*s']['LOG_message'] = $similarity_string;
+		}
+		if (
+			isset($this->_req_data['payment-filter-start-date'])
+			&& isset($this->_req_data['payment-filter-end-date'])
+		) {
+			// add date
+			$start_date = wp_strip_all_tags($this->_req_data['payment-filter-start-date']);
+			$end_date = wp_strip_all_tags($this->_req_data['payment-filter-end-date']);
+			// make sure our timestamps start and end right at the boundaries for each day
+			$start_date = date('Y-m-d', strtotime($start_date)) . ' 00:00:00';
+			$end_date = date('Y-m-d', strtotime($end_date)) . ' 23:59:59';
+			// convert to timestamps
+			$start_date = strtotime($start_date);
+			$end_date = strtotime($end_date);
+			// makes sure start date is the lowest value and vice versa
+			$start_date = min($start_date, $end_date);
+			$end_date = max($start_date, $end_date);
+			// convert for query
+			$start_date = EEM_Change_Log::instance()->convert_datetime_for_query(
+				'LOG_time',
+				date('Y-m-d H:i:s', $start_date),
+				'Y-m-d H:i:s'
+			);
+			$end_date   = EEM_Change_Log::instance()->convert_datetime_for_query(
+				'LOG_time',
+				date('Y-m-d H:i:s', $end_date),
+				'Y-m-d H:i:s'
+			);
+			$query_params[0]['LOG_time'] = array('BETWEEN', array($start_date, $end_date));
+		}
+		if ($count) {
+			return EEM_Change_Log::instance()->count($query_params);
+		}
+		if (isset($this->_req_data['order'])) {
+			$sort = (isset($this->_req_data['order']) && ! empty($this->_req_data['order']))
+				? $this->_req_data['order']
+				: 'DESC';
+			$query_params['order_by'] = array('LOG_time' => $sort);
+		} else {
+			$query_params['order_by'] = array('LOG_time' => 'DESC');
+		}
+		$offset = ($current_page - 1) * $per_page;
+		if (! isset($this->_req_data['download_results'])) {
+			$query_params['limit'] = array($offset, $per_page);
+		}
+		// now they've requested to instead just download the file instead of viewing it.
+		if (isset($this->_req_data['download_results'])) {
+			$wpdb_results = EEM_Change_Log::instance()->get_all_efficiently($query_params);
+			header('Content-Disposition: attachment');
+			header("Content-Disposition: attachment; filename=ee_payment_logs_for_" . sanitize_key(site_url()));
+			echo '<h1> '
+				. sprintf(
+					esc_html__('Payment Logs for %1$s', 'event_espresso'),
+					esc_url_raw(site_url())
+				)
+				. '</h1 >';
+			echo '<h3>' . esc_html__('Query:', 'event_espresso') . '</h3>';
+			echo esc_html(var_export($query_params, true));
+			echo '<h3>' . esc_html__('Results:', 'event_espresso') . '</h3>';
+			echo esc_html(var_export($wpdb_results, true));
+			die;
+		}
+		return EEM_Change_Log::instance()->get_all($query_params);
+	}
+
+
+	/**
+	 * Used by usort to RE-sort log query results, because we lose the ordering
+	 * because we're possibly combining the results from two queries
+	 *
+	 * @param EE_Change_Log $logA
+	 * @param EE_Change_Log $logB
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _sort_logs_again($logA, $logB)
+	{
+		$timeA = $logA->get_raw('LOG_time');
+		$timeB = $logB->get_raw('LOG_time');
+		if ($timeA == $timeB) {
+			return 0;
+		}
+		$comparison = $timeA < $timeB ? -1 : 1;
+		if (strtoupper($this->_sort_logs_again_direction) == 'DESC') {
+			return $comparison * -1;
+		}
+		return $comparison;
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _payment_log_details()
+	{
+		EE_Registry::instance()->load_model('Change_Log');
+		/** @var $payment_log EE_Change_Log */
+		$payment_log = EEM_Change_Log::instance()->get_one_by_ID($this->_req_data['ID']);
+		$payment_method = null;
+		$transaction = null;
+		if ($payment_log instanceof EE_Change_Log) {
+			if ($payment_log->object() instanceof EE_Payment) {
+				$payment_method = $payment_log->object()->payment_method();
+				$transaction = $payment_log->object()->transaction();
+			} elseif ($payment_log->object() instanceof EE_Payment_Method) {
+				$payment_method = $payment_log->object();
+			} elseif ($payment_log->object() instanceof EE_Transaction) {
+				$transaction = $payment_log->object();
+				$payment_method = $transaction->payment_method();
+			}
+		}
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			EE_PAYMENTS_TEMPLATE_PATH . 'payment_log_details.template.php',
+			array(
+				'payment_log'    => $payment_log,
+				'payment_method' => $payment_method,
+				'transaction'    => $transaction,
+			),
+			true
+		);
+		$this->display_admin_page_with_no_sidebar();
+	}
 }

admin_pages/about/About_Admin_Page.core.php

Indentation +278 added lines, -278 removed lines

@@ -15,132 +15,132 @@ 
  */
 class About_Admin_Page extends EE_Admin_Page
 {
-    protected function _init_page_props()
-    {
-        $this->page_slug = EE_ABOUT_PG_SLUG;
-        $this->page_label = esc_html__('About Event Espresso', 'event_espresso');
-        $this->_admin_base_url = EE_ABOUT_ADMIN_URL;
-        $this->_admin_base_path = EE_ABOUT_ADMIN;
-    }
-
-
-    protected function _ajax_hooks()
-    {
-        // todo: all hooks for ajax goes here.
-    }
-
-
-    protected function _define_page_props()
-    {
-        $this->_labels = array();
-        $this->_admin_page_title = $this->page_label;
-    }
-
-
-    protected function _set_page_routes()
-    {
-        $this->_page_routes = array(
-            'default' => array(
-                'func'       => '_overview',
-                'capability' => 'manage_options',
-            ),
-            // 'overview' => '_overview',
-            // 'func' => '_overview',
-            // 'capability' => 'ee_read_ee'
-            // ),
-            'credits' => array(
-                'func'       => '_credits',
-                'capability' => 'manage_options',
-            ),
-
-            'decafvpro' => array(
-                'func'       => '_decafvpro',
-                'capability' => 'manage_options',
-            ),
-            'reviews'   => array(
-                'func'       => '_reviews',
-                'capability' => 'manage_options',
-            ),
-        );
-    }
-
-
-    protected function _set_page_config()
-    {
-        $this->_page_config = array(
-            /*'default' => array(
+	protected function _init_page_props()
+	{
+		$this->page_slug = EE_ABOUT_PG_SLUG;
+		$this->page_label = esc_html__('About Event Espresso', 'event_espresso');
+		$this->_admin_base_url = EE_ABOUT_ADMIN_URL;
+		$this->_admin_base_path = EE_ABOUT_ADMIN;
+	}
+
+
+	protected function _ajax_hooks()
+	{
+		// todo: all hooks for ajax goes here.
+	}
+
+
+	protected function _define_page_props()
+	{
+		$this->_labels = array();
+		$this->_admin_page_title = $this->page_label;
+	}
+
+
+	protected function _set_page_routes()
+	{
+		$this->_page_routes = array(
+			'default' => array(
+				'func'       => '_overview',
+				'capability' => 'manage_options',
+			),
+			// 'overview' => '_overview',
+			// 'func' => '_overview',
+			// 'capability' => 'ee_read_ee'
+			// ),
+			'credits' => array(
+				'func'       => '_credits',
+				'capability' => 'manage_options',
+			),
+
+			'decafvpro' => array(
+				'func'       => '_decafvpro',
+				'capability' => 'manage_options',
+			),
+			'reviews'   => array(
+				'func'       => '_reviews',
+				'capability' => 'manage_options',
+			),
+		);
+	}
+
+
+	protected function _set_page_config()
+	{
+		$this->_page_config = array(
+			/*'default' => array(
                 'nav' => array(
                     'label' => esc_html__('What\'s New', 'event_espresso'),
                     'order' => 10),
                 'require_nonce' => FALSE
                 ),*/
-            // 'overview' => array(
-            'default' => array(
-                'nav'           => array(
-                    'label' => esc_html__('About', 'event_espresso'),
-                    'icon' => 'dashicons-welcome-learn-more',
-                    'order' => 20,
-                ),
-                'require_nonce' => false,
-            ),
-            'credits' => array(
-                'nav'           => array(
-                    'label' => esc_html__('Credits', 'event_espresso'),
-                    'icon' => 'dashicons-thumbs-up',
-                    'order' => 30,
-                ),
-                'require_nonce' => false,
-            ),
-
-            'decafvpro' => array(
-                'nav'           => array(
-                    'label' => esc_html__('Decaf vs Regular', 'event_espresso'),
-                    'icon' => 'dashicons-editor-code',
-                    'order' => 40,
-                ),
-                'require_nonce' => false,
-            ),
-            'reviews'   => array(
-                'nav'           => array(
-                    'label' => esc_html__('Reviews', 'event_espresso'),
-                    'icon' => 'dashicons-star-filled',
-                    'order' => 50,
-                ),
-                'require_nonce' => false,
-            ),
-        );
-    }
-
-
-    // none of the below group are currently used for Support pages
-    protected function _add_screen_options()
-    {
-    }
-
-    protected function _add_feature_pointers()
-    {
-    }
-
-    public function admin_init()
-    {
-    }
-
-    public function admin_notices()
-    {
-    }
-
-    public function admin_footer_scripts()
-    {
-    }
-
-    public function load_scripts_styles()
-    {
-    }
-
-
-    protected function _whats_new()
-    {
-        /*$steps = EE_Maintenance_Mode::instance()->level() != EE_Maintenance_Mode::level_2_complete_maintenance ? $this->_get_started_steps() : FALSE;
+			// 'overview' => array(
+			'default' => array(
+				'nav'           => array(
+					'label' => esc_html__('About', 'event_espresso'),
+					'icon' => 'dashicons-welcome-learn-more',
+					'order' => 20,
+				),
+				'require_nonce' => false,
+			),
+			'credits' => array(
+				'nav'           => array(
+					'label' => esc_html__('Credits', 'event_espresso'),
+					'icon' => 'dashicons-thumbs-up',
+					'order' => 30,
+				),
+				'require_nonce' => false,
+			),
+
+			'decafvpro' => array(
+				'nav'           => array(
+					'label' => esc_html__('Decaf vs Regular', 'event_espresso'),
+					'icon' => 'dashicons-editor-code',
+					'order' => 40,
+				),
+				'require_nonce' => false,
+			),
+			'reviews'   => array(
+				'nav'           => array(
+					'label' => esc_html__('Reviews', 'event_espresso'),
+					'icon' => 'dashicons-star-filled',
+					'order' => 50,
+				),
+				'require_nonce' => false,
+			),
+		);
+	}
+
+
+	// none of the below group are currently used for Support pages
+	protected function _add_screen_options()
+	{
+	}
+
+	protected function _add_feature_pointers()
+	{
+	}
+
+	public function admin_init()
+	{
+	}
+
+	public function admin_notices()
+	{
+	}
+
+	public function admin_footer_scripts()
+	{
+	}
+
+	public function load_scripts_styles()
+	{
+	}
+
+
+	protected function _whats_new()
+	{
+		/*$steps = EE_Maintenance_Mode::instance()->level() != EE_Maintenance_Mode::level_2_complete_maintenance ? $this->_get_started_steps() : FALSE;
         $steps = $steps !== FALSE ? $steps : '';
         $this->_admin_page_title = sprintf( esc_html__('Welcome to Event Espresso %s', 'event_espresso'), EVENT_ESPRESSO_VERSION );
         $settings_message = $steps;
@@ -148,168 +148,168 @@ 
         $template = EE_ABOUT_TEMPLATE_PATH . 'whats_new.template.php';
         $this->_template_args['about_admin_page_content'] = EEH_Template::display_template( $template, $this->_template_args, TRUE );
         $this->display_about_admin_page();*/
-    }
+	}
 
 
-    protected function _overview()
-    {
-        /*$this->_template_args['admin_page_title'] = esc_html__('About Event Espresso', 'event_espresso');
+	protected function _overview()
+	{
+		/*$this->_template_args['admin_page_title'] = esc_html__('About Event Espresso', 'event_espresso');
         $this->_template_args['admin_page_subtitle'] = esc_html__('Thank you for choosing Event Espresso Decaf, the most powerful, and free, Event Management plugin for WordPress.', 'event_espresso');
         $template = EE_ABOUT_TEMPLATE_PATH . 'ee4-overview.template.php';
         $this->_template_args['about_admin_page_content'] = EEH_Template::display_template( $template, $this->_template_args, TRUE );
         $this->display_about_admin_page();*/
 
-        // Copied from _whats_new()
-        $steps = EE_Maintenance_Mode::instance()->level() != EE_Maintenance_Mode::level_2_complete_maintenance
-            ? $this->_get_started_steps() : false;
-        $steps = $steps !== false ? $steps : '';
-        $this->_admin_page_title = sprintf(
-            esc_html__('Welcome to Event Espresso %s', 'event_espresso'),
-            EVENT_ESPRESSO_VERSION
-        );
-        $settings_message = $steps;
-        $this->_template_args['admin_page_subtitle'] = esc_html__(
-            'Thank you for choosing Event Espresso, the most powerful, and free, Event Management plugin for WordPress.',
-            'event_espresso'
-        ) . $settings_message;
-        $template = EE_ABOUT_TEMPLATE_PATH . 'ee4-overview.template.php';
-        $this->_template_args['about_admin_page_content'] = EEH_Template::display_template(
-            $template,
-            $this->_template_args,
-            true
-        );
-        $this->display_about_admin_page();
-    }
-
-
-    protected function _get_started_steps()
-    {
-        $steps = '<h2>' . esc_html__('Getting Started', 'event_espresso') . '</h2>';
-        $step_one = '<p>'
-                    . sprintf(
-                        esc_html__(
-                            '%sStep 1%s: Visit your %sOrganization Settings%s and add/update your details.',
-                            'event_espresso'
-                        ),
-                        '<strong>',
-                        '</strong>',
-                        '<a href="admin.php?page=espresso_general_settings">',
-                        '</a>'
-                    ) . '</strong></p>';
-        $step_two = '<p>'
-                    . sprintf(
-                        esc_html__('%sStep 2%s: Setup your %sPayment Methods%s.', 'event_espresso'),
-                        '<strong>',
-                        '</strong>',
-                        '<a href="admin.php?page=espresso_payment_settings">',
-                        '</a>'
-                    ) . '</strong></p>';
-        $step_three = '<p>'
-                      . sprintf(
-                          esc_html__('%sStep 3%s: Create your %sFirst Event%s.', 'event_espresso'),
-                          '<strong>',
-                          '</strong>',
-                          '<a href="admin.php?page=espresso_events&action=create_new">',
-                          '</a>'
-                      ) . '</strong></p>';
-
-        // done?
-        $done_step_one = EE_Registry::instance()->CFG->organization->address_1 == '123 Onna Road' ? false : true;
-        $active_invoice_pm = EEM_Payment_Method::instance()->get_one_active(
-            EEM_Payment_Method::scope_cart,
-            array(array('PMD_type' => 'Invoice'))
-        );
-        $active_pms_count = EEM_Payment_Method::instance()->count_active(EEM_Payment_Method::scope_cart);
-        // done step two if a non-invoice paymetn method is active; or there is more than one PM active, or
-        // if only the invoice is active but it's clearly been updated
-        $done_step_two = $active_pms_count > 1 ||
-                         ($active_pms_count === 1 && ! $active_invoice_pm) ||
-                         ($active_invoice_pm instanceof EE_Payment_Method && (
-                                 $active_invoice_pm->get_extra_meta('pdf_payee_name', true, '') ||
-                                 $active_invoice_pm->get_extra_meta('pdf_payee_email', true, '') ||
-                                 $active_invoice_pm->get_extra_meta('pdf_payee_tax_number', true, '') ||
-                                 $active_invoice_pm->get_extra_meta('pdf_payee_address', true, '') ||
-                                 $active_invoice_pm->get_extra_meta('page_extra_info', true, '')
-                             )
-                         );
-        $done_step_three = EE_Registry::instance()->load_model('Event')->count() > 0 ? true : false;
-
-        // if ALL steps are done, let's just return FALSE so we don't display anything
-        if ($done_step_one && $done_step_two && $done_step_three) {
-            return false;
-        }
-
-        // now let's put it together
-        $steps .= sprintf('%s' . $step_one . '%s', $done_step_one ? '<strike>' : '', $done_step_one ? '</strike>' : '');
-        $steps .= sprintf('%s' . $step_two . '%s', $done_step_two ? '<strike>' : '', $done_step_two ? '</strike>' : '');
-        $steps .= sprintf(
-            '%s' . $step_three . '%s',
-            $done_step_three ? '<strike>' : '',
-            $done_step_three ? '</strike>' : ''
-        );
-
-        return $steps;
-    }
-
-
-    protected function _credits()
-    {
-        $this->_template_args['admin_page_title'] = sprintf(
-            esc_html__('Welcome to Event Espresso %s', 'event_espresso'),
-            EVENT_ESPRESSO_VERSION
-        );
-        $this->_template_args['admin_page_subtitle'] = esc_html__(
-            'Thank you for choosing Event Espresso Decaf, the most powerful, and free, Event Management plugin for WordPress.',
-            'event_espresso'
-        );
-        $template = EE_ABOUT_TEMPLATE_PATH . 'credits.template.php';
-        $this->_template_args['about_admin_page_content'] = EEH_Template::display_template(
-            $template,
-            $this->_template_args,
-            true
-        );
-        $this->display_about_admin_page();
-    }
-
-
-    protected function _decafvpro()
-    {
-        $this->_template_args['admin_page_title'] = sprintf(
-            esc_html__('Welcome to Event Espresso %s', 'event_espresso'),
-            EVENT_ESPRESSO_VERSION
-        );
-        $this->_template_args['admin_page_subtitle'] = sprintf(
-            esc_html__(
-                'Event Espresso lets you focus on doing %swhat you love%s — %sorganizing your events%s',
-                'event_espresso'
-            ),
-            '<em>',
-            '</em>',
-            '<strong>',
-            '</strong>'
-        );
-        $template = EE_ABOUT_TEMPLATE_PATH . 'decafvpro.template.php';
-        $this->_template_args['about_admin_page_content'] = EEH_Template::display_template(
-            $template,
-            $this->_template_args,
-            true
-        );
-        $this->display_about_admin_page();
-    }
-
-    protected function _reviews()
-    {
-        $this->_template_args['admin_page_title'] = esc_html__('Rave Reviews About Event Espresso 4', 'event_espresso');
-        $this->_template_args['admin_page_subtitle'] = esc_html__(
-            'At Event Espresso, customer satisfaction is our ultimate goal.',
-            'event_espresso'
-        );
-        $template = EE_ABOUT_TEMPLATE_PATH . 'reviews.template.php';
-        $this->_template_args['about_admin_page_content'] = EEH_Template::display_template(
-            $template,
-            $this->_template_args,
-            true
-        );
-        $this->display_about_admin_page();
-    }
+		// Copied from _whats_new()
+		$steps = EE_Maintenance_Mode::instance()->level() != EE_Maintenance_Mode::level_2_complete_maintenance
+			? $this->_get_started_steps() : false;
+		$steps = $steps !== false ? $steps : '';
+		$this->_admin_page_title = sprintf(
+			esc_html__('Welcome to Event Espresso %s', 'event_espresso'),
+			EVENT_ESPRESSO_VERSION
+		);
+		$settings_message = $steps;
+		$this->_template_args['admin_page_subtitle'] = esc_html__(
+			'Thank you for choosing Event Espresso, the most powerful, and free, Event Management plugin for WordPress.',
+			'event_espresso'
+		) . $settings_message;
+		$template = EE_ABOUT_TEMPLATE_PATH . 'ee4-overview.template.php';
+		$this->_template_args['about_admin_page_content'] = EEH_Template::display_template(
+			$template,
+			$this->_template_args,
+			true
+		);
+		$this->display_about_admin_page();
+	}
+
+
+	protected function _get_started_steps()
+	{
+		$steps = '<h2>' . esc_html__('Getting Started', 'event_espresso') . '</h2>';
+		$step_one = '<p>'
+					. sprintf(
+						esc_html__(
+							'%sStep 1%s: Visit your %sOrganization Settings%s and add/update your details.',
+							'event_espresso'
+						),
+						'<strong>',
+						'</strong>',
+						'<a href="admin.php?page=espresso_general_settings">',
+						'</a>'
+					) . '</strong></p>';
+		$step_two = '<p>'
+					. sprintf(
+						esc_html__('%sStep 2%s: Setup your %sPayment Methods%s.', 'event_espresso'),
+						'<strong>',
+						'</strong>',
+						'<a href="admin.php?page=espresso_payment_settings">',
+						'</a>'
+					) . '</strong></p>';
+		$step_three = '<p>'
+					  . sprintf(
+						  esc_html__('%sStep 3%s: Create your %sFirst Event%s.', 'event_espresso'),
+						  '<strong>',
+						  '</strong>',
+						  '<a href="admin.php?page=espresso_events&action=create_new">',
+						  '</a>'
+					  ) . '</strong></p>';
+
+		// done?
+		$done_step_one = EE_Registry::instance()->CFG->organization->address_1 == '123 Onna Road' ? false : true;
+		$active_invoice_pm = EEM_Payment_Method::instance()->get_one_active(
+			EEM_Payment_Method::scope_cart,
+			array(array('PMD_type' => 'Invoice'))
+		);
+		$active_pms_count = EEM_Payment_Method::instance()->count_active(EEM_Payment_Method::scope_cart);
+		// done step two if a non-invoice paymetn method is active; or there is more than one PM active, or
+		// if only the invoice is active but it's clearly been updated
+		$done_step_two = $active_pms_count > 1 ||
+						 ($active_pms_count === 1 && ! $active_invoice_pm) ||
+						 ($active_invoice_pm instanceof EE_Payment_Method && (
+								 $active_invoice_pm->get_extra_meta('pdf_payee_name', true, '') ||
+								 $active_invoice_pm->get_extra_meta('pdf_payee_email', true, '') ||
+								 $active_invoice_pm->get_extra_meta('pdf_payee_tax_number', true, '') ||
+								 $active_invoice_pm->get_extra_meta('pdf_payee_address', true, '') ||
+								 $active_invoice_pm->get_extra_meta('page_extra_info', true, '')
+							 )
+						 );
+		$done_step_three = EE_Registry::instance()->load_model('Event')->count() > 0 ? true : false;
+
+		// if ALL steps are done, let's just return FALSE so we don't display anything
+		if ($done_step_one && $done_step_two && $done_step_three) {
+			return false;
+		}
+
+		// now let's put it together
+		$steps .= sprintf('%s' . $step_one . '%s', $done_step_one ? '<strike>' : '', $done_step_one ? '</strike>' : '');
+		$steps .= sprintf('%s' . $step_two . '%s', $done_step_two ? '<strike>' : '', $done_step_two ? '</strike>' : '');
+		$steps .= sprintf(
+			'%s' . $step_three . '%s',
+			$done_step_three ? '<strike>' : '',
+			$done_step_three ? '</strike>' : ''
+		);
+
+		return $steps;
+	}
+
+
+	protected function _credits()
+	{
+		$this->_template_args['admin_page_title'] = sprintf(
+			esc_html__('Welcome to Event Espresso %s', 'event_espresso'),
+			EVENT_ESPRESSO_VERSION
+		);
+		$this->_template_args['admin_page_subtitle'] = esc_html__(
+			'Thank you for choosing Event Espresso Decaf, the most powerful, and free, Event Management plugin for WordPress.',
+			'event_espresso'
+		);
+		$template = EE_ABOUT_TEMPLATE_PATH . 'credits.template.php';
+		$this->_template_args['about_admin_page_content'] = EEH_Template::display_template(
+			$template,
+			$this->_template_args,
+			true
+		);
+		$this->display_about_admin_page();
+	}
+
+
+	protected function _decafvpro()
+	{
+		$this->_template_args['admin_page_title'] = sprintf(
+			esc_html__('Welcome to Event Espresso %s', 'event_espresso'),
+			EVENT_ESPRESSO_VERSION
+		);
+		$this->_template_args['admin_page_subtitle'] = sprintf(
+			esc_html__(
+				'Event Espresso lets you focus on doing %swhat you love%s — %sorganizing your events%s',
+				'event_espresso'
+			),
+			'<em>',
+			'</em>',
+			'<strong>',
+			'</strong>'
+		);
+		$template = EE_ABOUT_TEMPLATE_PATH . 'decafvpro.template.php';
+		$this->_template_args['about_admin_page_content'] = EEH_Template::display_template(
+			$template,
+			$this->_template_args,
+			true
+		);
+		$this->display_about_admin_page();
+	}
+
+	protected function _reviews()
+	{
+		$this->_template_args['admin_page_title'] = esc_html__('Rave Reviews About Event Espresso 4', 'event_espresso');
+		$this->_template_args['admin_page_subtitle'] = esc_html__(
+			'At Event Espresso, customer satisfaction is our ultimate goal.',
+			'event_espresso'
+		);
+		$template = EE_ABOUT_TEMPLATE_PATH . 'reviews.template.php';
+		$this->_template_args['about_admin_page_content'] = EEH_Template::display_template(
+			$template,
+			$this->_template_args,
+			true
+		);
+		$this->display_about_admin_page();
+	}
 }

admin_pages/about/templates/credits.template.php

Indentation +86 added lines, -86 removed lines

@@ -1,61 +1,61 @@ 
 <?php
 $tEEm_members = [
-    esc_html__('Founders', 'event_espresso') => [
-        'garth-koyle' => [
-            'email' => 'garth@eventespresso.com',
-            'name'  => 'Garth Koyle',
-            'desc'  => esc_html__('Co-Founder', 'event_espresso'),
-        ],
-    ],
-    esc_html__('Core Developers', 'event_espresso') => [
-        'brent-christensen' => [
-            'email' => 'brent@eventespresso.com',
-            'name'  => 'Brent Christensen',
-            'desc'  => esc_html__('Lead Developer', 'event_espresso'),
-        ],
-        'nazar-kolivoshka' => [
-            'email' => 'nazar@eventespresso.com',
-            'name'  => 'Nazar Kolivoshka',
-            'desc'  => esc_html__('Core Developer', 'event_espresso'),
-        ],
-        'marlon-hario' => [
-            'email' => 'marlon@eventespresso.com',
-            'name'  => 'Marlon Hario',
-            'desc'  => esc_html__('Core Developer', 'event_espresso'),
-        ],
-        'hossein-rafiei' => [
-            'email' => 'hossein@eventespresso.com',
-            'name'  => 'Hossein Rafiei',
-            'desc'  => esc_html__('Core Developer', 'event_espresso'),
-        ],
-    ],
-    esc_html__('Support Staff', 'event_espresso') => [
-        'tony-warwick' => [
-            'email' => 'tony@eventespresso.com',
-            'name'  => 'Tony Warwick',
-            'desc'  => esc_html__('Support', 'event_espresso'),
-        ],
-        'lorenzo-caum' => [
-            'email' => 'lorenzo@eventespresso.com',
-            'name'  => 'Lorenzo Caum',
-            'desc'  => esc_html__('Sales & Support', 'event_espresso'),
-        ],
-        'janice-gutierrez' => [
-            'email' => 'janice@eventespresso.com',
-            'name'  => 'Janice Gutierrez',
-            'desc'  => esc_html__('Support', 'event_espresso'),
-        ],
-        'chinny-love-verana' => [
-            'email' => 'chinny@eventespresso.com',
-            'name'  => 'Chinny Love Verana',
-            'desc'  => esc_html__('Sales & Support', 'event_espresso'),
-        ],
-    ],
+	esc_html__('Founders', 'event_espresso') => [
+		'garth-koyle' => [
+			'email' => 'garth@eventespresso.com',
+			'name'  => 'Garth Koyle',
+			'desc'  => esc_html__('Co-Founder', 'event_espresso'),
+		],
+	],
+	esc_html__('Core Developers', 'event_espresso') => [
+		'brent-christensen' => [
+			'email' => 'brent@eventespresso.com',
+			'name'  => 'Brent Christensen',
+			'desc'  => esc_html__('Lead Developer', 'event_espresso'),
+		],
+		'nazar-kolivoshka' => [
+			'email' => 'nazar@eventespresso.com',
+			'name'  => 'Nazar Kolivoshka',
+			'desc'  => esc_html__('Core Developer', 'event_espresso'),
+		],
+		'marlon-hario' => [
+			'email' => 'marlon@eventespresso.com',
+			'name'  => 'Marlon Hario',
+			'desc'  => esc_html__('Core Developer', 'event_espresso'),
+		],
+		'hossein-rafiei' => [
+			'email' => 'hossein@eventespresso.com',
+			'name'  => 'Hossein Rafiei',
+			'desc'  => esc_html__('Core Developer', 'event_espresso'),
+		],
+	],
+	esc_html__('Support Staff', 'event_espresso') => [
+		'tony-warwick' => [
+			'email' => 'tony@eventespresso.com',
+			'name'  => 'Tony Warwick',
+			'desc'  => esc_html__('Support', 'event_espresso'),
+		],
+		'lorenzo-caum' => [
+			'email' => 'lorenzo@eventespresso.com',
+			'name'  => 'Lorenzo Caum',
+			'desc'  => esc_html__('Sales & Support', 'event_espresso'),
+		],
+		'janice-gutierrez' => [
+			'email' => 'janice@eventespresso.com',
+			'name'  => 'Janice Gutierrez',
+			'desc'  => esc_html__('Support', 'event_espresso'),
+		],
+		'chinny-love-verana' => [
+			'email' => 'chinny@eventespresso.com',
+			'name'  => 'Chinny Love Verana',
+			'desc'  => esc_html__('Sales & Support', 'event_espresso'),
+		],
+	],
 ];
 
 function espressoPerson($id, $email, $name, $desc): string
 {
-    return '
+	return '
     <li class="ee-card ee-credits-person" id="ee-person-' . $id . '">
         <a href="' . esp_gravatar_profile($email) . '" target="_blank">
             ' . esp_gravatar_image($email, $name) . '
@@ -69,15 +69,15 @@ 
 
 function esp_gravatar_profile($email)
 {
-    return esc_url_raw('https://www.gravatar.com/' . md5($email));
+	return esc_url_raw('https://www.gravatar.com/' . md5($email));
 }
 
 function esp_gravatar_image($email, $name)
 {
-    $email = md5($email);
-    $name  = esc_attr($name);
-    $url   = esc_url_raw("https://0.gravatar.com/avatar/{$email}?s=60");
-    return "<img src='{$url}' class='gravatar' alt='{$name}'/>";
+	$email = md5($email);
+	$name  = esc_attr($name);
+	$url   = esc_url_raw("https://0.gravatar.com/avatar/{$email}?s=60");
+	return "<img src='{$url}' class='gravatar' alt='{$name}'/>";
 }
 
 ?>
@@ -87,38 +87,38 @@ 
 
         <h4>
             <?php esc_html_e(
-                'Event Espresso is created by an international team of passionate individuals with a drive to empower your events!',
-                'event_espresso'
-            ); ?>
+				'Event Espresso is created by an international team of passionate individuals with a drive to empower your events!',
+				'event_espresso'
+			); ?>
         </h4>
 
         <div class='ee-credits-tEEm'>
             <?php
-            foreach ($tEEm_members as $tEEm => $members) {
-                echo '
+			foreach ($tEEm_members as $tEEm => $members) {
+				echo '
             <h3 class="wp-people-group">' . $tEEm . '</h3>
             <ul class="ee-card-grid ee-card-grid-4-cols" id="' . sanitize_key($tEEm) . '">';
-                foreach ($members as $id => $person) {
-                    echo espressoPerson($id, $person['email'], $person['name'], $person['desc']);
-                }
-                echo '
+				foreach ($members as $id => $person) {
+					echo espressoPerson($id, $person['email'], $person['name'], $person['desc']);
+				}
+				echo '
             </ul>';
-            }
-            ?>
+			}
+			?>
         </div>
 
         <h3 class="wp-people-group"><?php esc_html_e('Contributor Recognition', 'event_espresso'); ?></h3>
         <p class="description">
             <?php
-            printf(
-                esc_html__(
-                    'For every major release we want to recognize the people who contributed to the release via a GitHub pull request. Want to see your name listed here? %sWhen you submit a pull request that gets included in a major release%s, we\'ll add your name here linked to your GitHub profile.',
-                    'event_espresso'
-                ),
-                '<a href="https://github.com/eventespresso/event-espresso-core" title="Contribute to Event Espresso by making a pull request via GitHub" target="_blank">',
-                '</a>'
-            );
-            ?>
+			printf(
+				esc_html__(
+					'For every major release we want to recognize the people who contributed to the release via a GitHub pull request. Want to see your name listed here? %sWhen you submit a pull request that gets included in a major release%s, we\'ll add your name here linked to your GitHub profile.',
+					'event_espresso'
+				),
+				'<a href="https://github.com/eventespresso/event-espresso-core" title="Contribute to Event Espresso by making a pull request via GitHub" target="_blank">',
+				'</a>'
+			);
+			?>
         </p>
         <p class="wp-credits-list">
         <ul>
@@ -133,15 +133,15 @@ 
         <h3 class="wp-people-group"><?php esc_html_e('External Libraries', 'event_espresso'); ?></h3>
         <p class="description">
             <?php
-            printf(
-                esc_html__(
-                    'Along with the libraries %sincluded with WordPress%s, Event Espresso utilizes the following third party libraries:',
-                    'event_espresso'
-                ),
-                '<a href="credits.php">',
-                '</a>'
-            );
-            ?>
+			printf(
+				esc_html__(
+					'Along with the libraries %sincluded with WordPress%s, Event Espresso utilizes the following third party libraries:',
+					'event_espresso'
+				),
+				'<a href="credits.php">',
+				'</a>'
+			);
+			?>
         </p>
         <p class="wp-credits-list">
             <a href="https://openexchangerates.github.io/accounting.js/" target='_blank'>accounting.js</a>,

Spacing +8 added lines, -8 removed lines

@@ -56,20 +56,20 @@ 
 function espressoPerson($id, $email, $name, $desc): string
 {
     return '
-    <li class="ee-card ee-credits-person" id="ee-person-' . $id . '">
-        <a href="' . esp_gravatar_profile($email) . '" target="_blank">
-            ' . esp_gravatar_image($email, $name) . '
+    <li class="ee-card ee-credits-person" id="ee-person-' . $id.'">
+        <a href="' . esp_gravatar_profile($email).'" target="_blank">
+            ' . esp_gravatar_image($email, $name).'
         </a>
         <p>
-            <a class="web" href="' . esp_gravatar_profile($email) . '" target="_blank">' . $name . '</a>
-            <span class="title">' . $desc . '</span>
+            <a class="web" href="' . esp_gravatar_profile($email).'" target="_blank">'.$name.'</a>
+            <span class="title">' . $desc.'</span>
         </p>
     </li>';
 }
 
 function esp_gravatar_profile($email)
 {
-    return esc_url_raw('https://www.gravatar.com/' . md5($email));
+    return esc_url_raw('https://www.gravatar.com/'.md5($email));
 }
 
 function esp_gravatar_image($email, $name)
@@ -96,8 +96,8 @@ 
             <?php
             foreach ($tEEm_members as $tEEm => $members) {
                 echo '
-            <h3 class="wp-people-group">' . $tEEm . '</h3>
-            <ul class="ee-card-grid ee-card-grid-4-cols" id="' . sanitize_key($tEEm) . '">';
+            <h3 class="wp-people-group">' . $tEEm.'</h3>
+            <ul class="ee-card-grid ee-card-grid-4-cols" id="' . sanitize_key($tEEm).'">';
                 foreach ($members as $id => $person) {
                     echo espressoPerson($id, $person['email'], $person['name'], $person['desc']);
                 }

admin_pages/maintenance/Maintenance_Admin_Page.core.php

Indentation +952 added lines, -952 removed lines

@@ -14,956 +14,956 @@
  */
 class Maintenance_Admin_Page extends EE_Admin_Page
 {
-    /**
-     * @var EE_Data_Migration_Manager
-     */
-    protected $migration_manager;
-
-    /**
-     * @var EE_Maintenance_Mode
-     */
-    protected $maintenance_mode;
-
-    /**
-     * @var EE_Form_Section_Proper
-     */
-    protected $datetime_fix_offset_form;
-
-
-    /**
-     * @param bool $routing
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function __construct($routing = true)
-    {
-        $this->migration_manager = EE_Data_Migration_Manager::instance();
-        $this->maintenance_mode  = EE_Maintenance_Mode::instance();
-        parent::__construct($routing);
-    }
-
-
-    protected function _init_page_props()
-    {
-        $this->page_slug        = EE_MAINTENANCE_PG_SLUG;
-        $this->page_label       = EE_MAINTENANCE_LABEL;
-        $this->_admin_base_url  = EE_MAINTENANCE_ADMIN_URL;
-        $this->_admin_base_path = EE_MAINTENANCE_ADMIN;
-    }
-
-
-    protected function _ajax_hooks()
-    {
-        add_action('wp_ajax_migration_step', [$this, 'migration_step']);
-        add_action('wp_ajax_add_error_to_migrations_ran', [$this, 'add_error_to_migrations_ran']);
-    }
-
-
-    protected function _define_page_props()
-    {
-        $this->_admin_page_title = EE_MAINTENANCE_LABEL;
-        $this->_labels           = [
-            'buttons' => [
-                'reset_reservations' => esc_html__('Reset Ticket and Datetime Reserved Counts', 'event_espresso'),
-                'reset_capabilities' => esc_html__('Reset Event Espresso Capabilities', 'event_espresso'),
-            ],
-        ];
-    }
-
-
-    protected function _set_page_routes()
-    {
-        $this->_page_routes = [
-            'default'                             => [
-                'func'       => '_maintenance',
-                'capability' => 'manage_options',
-            ],
-            'change_maintenance_level'            => [
-                'func'       => '_change_maintenance_level',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ],
-            'system_status'                       => [
-                'func'       => '_system_status',
-                'capability' => 'manage_options',
-            ],
-            'download_system_status'              => [
-                'func'       => '_download_system_status',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ],
-            'send_migration_crash_report'         => [
-                'func'       => '_send_migration_crash_report',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ],
-            'confirm_migration_crash_report_sent' => [
-                'func'       => '_confirm_migration_crash_report_sent',
-                'capability' => 'manage_options',
-            ],
-            'data_reset'                          => [
-                'func'       => '_data_reset_and_delete',
-                'capability' => 'manage_options',
-            ],
-            'reset_db'                            => [
-                'func'       => '_reset_db',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-                'args'       => ['nuke_old_ee4_data' => true],
-            ],
-            'start_with_fresh_ee4_db'             => [
-                'func'       => '_reset_db',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-                'args'       => ['nuke_old_ee4_data' => false],
-            ],
-            'delete_db'                           => [
-                'func'       => '_delete_db',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ],
-            'rerun_migration_from_ee3'            => [
-                'func'       => '_rerun_migration_from_ee3',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ],
-            'reset_reservations'                  => [
-                'func'       => '_reset_reservations',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ],
-            'reset_capabilities'                  => [
-                'func'       => '_reset_capabilities',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ],
-            'reattempt_migration'                 => [
-                'func'       => '_reattempt_migration',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ],
-            'datetime_tools'                      => [
-                'func'       => '_datetime_tools',
-                'capability' => 'manage_options',
-            ],
-            'run_datetime_offset_fix'             => [
-                'func'               => '_apply_datetime_offset',
-                'noheader'           => true,
-                'headers_sent_route' => 'datetime_tools',
-                'capability'         => 'manage_options',
-            ],
-        ];
-    }
-
-
-    protected function _set_page_config()
-    {
-        $this->_page_config = [
-            'default'        => [
-                'nav'           => [
-                    'label' => esc_html__('Maintenance', 'event_espresso'),
-                    'icon' => 'dashicons-admin-tools',
-                    'order' => 10,
-                ],
-                'require_nonce' => false,
-            ],
-            'data_reset'     => [
-                'nav'           => [
-                    'label' => esc_html__('Reset/Delete Data', 'event_espresso'),
-                    'icon' => 'dashicons-trash',
-                    'order' => 20,
-                ],
-                'require_nonce' => false,
-            ],
-            'datetime_tools' => [
-                'nav'           => [
-                    'label' => esc_html__('Datetime Utilities', 'event_espresso'),
-                    'icon' => 'dashicons-calendar-alt',
-                    'order' => 25,
-                ],
-                'require_nonce' => false,
-            ],
-            'system_status'  => [
-                'nav'           => [
-                    'label' => esc_html__("System Information", "event_espresso"),
-                    'icon' => 'dashicons-info',
-                    'order' => 30,
-                ],
-                'require_nonce' => false,
-            ],
-        ];
-    }
-
-
-    /**
-     * default maintenance page.
-     * If we're in maintenance mode level 2, then we need to show the migration scripts and all that UI.
-     *
-     * @throws EE_Error
-     */
-    public function _maintenance()
-    {
-        $show_maintenance_switch         = true;
-        $show_backup_db_text             = false;
-        $show_migration_progress         = false;
-        $script_names                    = [];
-        $addons_should_be_upgraded_first = false;
-        // it all depends on if we're in maintenance model level 1 (frontend-only) or
-        // level 2 (everything except maintenance page)
-        try {
-            // get the current maintenance level and check if
-            // we are removed
-            $mMode_level  = $this->maintenance_mode->level();
-            $placed_in_mm = $this->maintenance_mode->set_maintenance_mode_if_db_old();
-            if ($mMode_level == EE_Maintenance_Mode::level_2_complete_maintenance && ! $placed_in_mm) {
-                // we just took the site out of maintenance mode, so notify the user.
-                // unfortunately this message appears to be echoed on the NEXT page load...
-                // oh well, we should really be checking for this on addon deactivation anyways
-                EE_Error::add_attention(
-                    esc_html__(
-                        'Site taken out of maintenance mode because no data migration scripts are required',
-                        'event_espresso'
-                    )
-                );
-                $this->_process_notices(['page' => 'espresso_maintenance_settings']);
-            }
-            // in case an exception is thrown while trying to handle migrations
-            if ($mMode_level === EE_Maintenance_Mode::level_2_complete_maintenance) {
-                $show_maintenance_switch = false;
-                $show_migration_progress = true;
-                if (isset($this->_req_data['continue_migration'])) {
-                    $show_backup_db_text = false;
-                } else {
-                    $show_backup_db_text = true;
-                }
-                $scripts_needing_to_run          =
-                    $this->migration_manager->check_for_applicable_data_migration_scripts();
-                $addons_should_be_upgraded_first = $this->migration_manager->addons_need_updating();
-                $script_names                    = [];
-                $current_script                  = null;
-                foreach ($scripts_needing_to_run as $script) {
-                    if ($script instanceof EE_Data_Migration_Script_Base) {
-                        if (! $current_script) {
-                            $current_script = $script;
-                            $current_script->migration_page_hooks();
-                        }
-                        $script_names[] = $script->pretty_name();
-                    }
-                }
-            }
-            $most_recent_migration = $this->migration_manager->get_last_ran_script(true);
-            $exception_thrown      = false;
-        } catch (EE_Error $e) {
-            $this->migration_manager->add_error_to_migrations_ran($e->getMessage());
-            // now, just so we can display the page correctly, make an error migration script stage object
-            // and also put the error on it. It only persists for the duration of this request
-            $most_recent_migration = new EE_DMS_Unknown_1_0_0();
-            $most_recent_migration->add_error($e->getMessage());
-            $exception_thrown = true;
-        }
-        $current_db_state = $this->migration_manager->ensure_current_database_state_is_set();
-        $current_db_state = str_replace('.decaf', '', $current_db_state);
-        if (
-            $exception_thrown
-            || (
-                $most_recent_migration instanceof EE_Data_Migration_Script_Base
-                && $most_recent_migration->is_broken()
-            )
-        ) {
-            $this->_template_path                =
-                EE_MAINTENANCE_TEMPLATE_PATH . 'ee_migration_was_borked_page.template.php';
-            $this->_template_args['support_url'] = 'https://eventespresso.com/support/forums/';
-            $this->_template_args['next_url']    = EEH_URL::add_query_args_and_nonce(
-                [
-                    'action'  => 'confirm_migration_crash_report_sent',
-                    'success' => '0',
-                ],
-                EE_MAINTENANCE_ADMIN_URL
-            );
-        } elseif ($addons_should_be_upgraded_first) {
-            $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_upgrade_addons_before_migrating.template.php';
-        } else {
-            if (
-                $most_recent_migration instanceof EE_Data_Migration_Script_Base
-                && $most_recent_migration->can_continue()
-            ) {
-                $show_backup_db_text                    = false;
-                $show_continue_current_migration_script = true;
-                $show_most_recent_migration             = true;
-            } elseif (isset($this->_req_data['continue_migration'])) {
-                $show_most_recent_migration             = true;
-                $show_continue_current_migration_script = false;
-            } else {
-                $show_most_recent_migration             = false;
-                $show_continue_current_migration_script = false;
-            }
-            if (isset($current_script)) {
-                $migrates_to          = $current_script->migrates_to_version();
-                $plugin_slug          = $migrates_to['slug'];
-                $new_version          = $migrates_to['version'];
-                $this->_template_args = array_merge(
-                    $this->_template_args,
-                    [
-                        'current_db_state' => sprintf(
-                            esc_html__("EE%s (%s)", "event_espresso"),
-                            isset($current_db_state[ $plugin_slug ]) ? $current_db_state[ $plugin_slug ] : 3,
-                            $plugin_slug
-                        ),
-                        'next_db_state'    => sprintf(
-                            esc_html__("EE%s (%s)", 'event_espresso'),
-                            $new_version,
-                            $plugin_slug
-                        ),
-                    ]
-                );
-            } else {
-                $this->_template_args['current_db_state'] = null;
-                $this->_template_args['next_db_state']    = null;
-            }
-            $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_migration_page.template.php';
-            $this->_template_args = array_merge(
-                $this->_template_args,
-                [
-                    'show_most_recent_migration'             => $show_most_recent_migration,
-                    // flag for showing the most recent migration's status and/or errors
-                    'show_migration_progress'                => $show_migration_progress,
-                    // flag for showing the option to run migrations and see their progress
-                    'show_backup_db_text'                    => $show_backup_db_text,
-                    // flag for showing text telling the user to back up their DB
-                    'show_maintenance_switch'                => $show_maintenance_switch,
-                    // flag for showing the option to change maintenance mode between levels 0 and 1
-                    'script_names'                           => $script_names,
-                    // array of names of scripts that have run
-                    'show_continue_current_migration_script' => $show_continue_current_migration_script,
-                    // flag to change wording to indicating that we're only CONTINUING a migration script (somehow it got interrupted0
-                    'reset_db_page_link'                     => EE_Admin_Page::add_query_args_and_nonce(
-                        ['action' => 'reset_db'],
-                        EE_MAINTENANCE_ADMIN_URL
-                    ),
-                    'data_reset_page'                        => EE_Admin_Page::add_query_args_and_nonce(
-                        ['action' => 'data_reset'],
-                        EE_MAINTENANCE_ADMIN_URL
-                    ),
-                    'update_migration_script_page_link'      => EE_Admin_Page::add_query_args_and_nonce(
-                        ['action' => 'change_maintenance_level'],
-                        EE_MAINTENANCE_ADMIN_URL
-                    ),
-                    'ultimate_db_state'                      => sprintf(
-                        esc_html__("EE%s", 'event_espresso'),
-                        espresso_version()
-                    ),
-                ]
-            );
-        }
-        $this->_template_args['most_recent_migration'] =
-            $most_recent_migration;// the actual most recently ran migration
-        // now render the migration options part, and put it in a variable
-        $migration_options_template_file                = apply_filters(
-            'FHEE__ee_migration_page__migration_options_template',
-            EE_MAINTENANCE_TEMPLATE_PATH . 'migration_options_from_ee4.template.php'
-        );
-        $migration_options_html                         = EEH_Template::display_template(
-            $migration_options_template_file,
-            $this->_template_args,
-            true
-        );
-        $this->_template_args['migration_options_html'] = $migration_options_html;
-        $this->_template_args['admin_page_content']     = EEH_Template::display_template(
-            $this->_template_path,
-            $this->_template_args,
-            true
-        );
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * returns JSON and executes another step of the currently-executing data migration (called via ajax)
-     *
-     * @throws EE_Error
-     */
-    public function migration_step()
-    {
-        $this->_template_args['data'] = $this->migration_manager->response_to_migration_ajax_request();
-        $this->_return_json();
-    }
-
-
-    /**
-     * Can be used by js when it notices a response with HTML in it in order
-     * to log the malformed response
-     *
-     * @throws EE_Error
-     */
-    public function add_error_to_migrations_ran()
-    {
-        $this->migration_manager->add_error_to_migrations_ran($this->_req_data['message']);
-        $this->_template_args['data'] = ['ok' => true];
-        $this->_return_json();
-    }
-
-
-    /**
-     * changes the maintenance level, provided there are still no migration scripts that should run
-     *
-     * @throws EE_Error
-     */
-    public function _change_maintenance_level()
-    {
-        $new_level = absint($this->_req_data['maintenance_mode_level']);
-        if (! $this->migration_manager->check_for_applicable_data_migration_scripts()) {
-            $this->maintenance_mode->set_maintenance_level($new_level);
-            $success = true;
-        } else {
-            $this->maintenance_mode->set_maintenance_mode_if_db_old();
-            $success = false;
-        }
-        $this->_redirect_after_action($success, 'Maintenance Mode', esc_html__("Updated", "event_espresso"));
-    }
-
-
-    /**
-     * a tab with options for resetting and/or deleting EE data
-     *
-     * @throws EE_Error
-     * @throws DomainException
-     */
-    public function _data_reset_and_delete()
-    {
-        $this->_template_path                              =
-            EE_MAINTENANCE_TEMPLATE_PATH . 'ee_data_reset_and_delete.template.php';
-        $this->_template_args['reset_reservations_button'] = $this->get_action_link_or_button(
-            'reset_reservations',
-            'reset_reservations',
-            [],
-            'button button--caution ee-confirm'
-        );
-        $this->_template_args['reset_capabilities_button'] = $this->get_action_link_or_button(
-            'reset_capabilities',
-            'reset_capabilities',
-            [],
-            'button button--caution ee-confirm'
-        );
-        $this->_template_args['delete_db_url']             = EE_Admin_Page::add_query_args_and_nonce(
-            ['action' => 'delete_db'],
-            EE_MAINTENANCE_ADMIN_URL
-        );
-        $this->_template_args['reset_db_url']              = EE_Admin_Page::add_query_args_and_nonce(
-            ['action' => 'reset_db'],
-            EE_MAINTENANCE_ADMIN_URL
-        );
-        $this->_template_args['admin_page_content']        = EEH_Template::display_template(
-            $this->_template_path,
-            $this->_template_args,
-            true
-        );
-        $this->display_admin_page_with_no_sidebar();
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _reset_reservations()
-    {
-        if (EED_Ticket_Sales_Monitor::reset_reservation_counts()) {
-            EE_Error::add_success(
-                esc_html__(
-                    'Ticket and datetime reserved counts have been successfully reset.',
-                    'event_espresso'
-                )
-            );
-        } else {
-            EE_Error::add_success(
-                esc_html__(
-                    'Ticket and datetime reserved counts were correct and did not need resetting.',
-                    'event_espresso'
-                )
-            );
-        }
-        $this->_redirect_after_action(true, '', '', ['action' => 'data_reset'], true);
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    protected function _reset_capabilities()
-    {
-        EE_Registry::instance()->CAP->init_caps(true);
-        EE_Error::add_success(
-            esc_html__(
-                'Default Event Espresso capabilities have been restored for all current roles.',
-                'event_espresso'
-            )
-        );
-        $this->_redirect_after_action(false, '', '', ['action' => 'data_reset'], true);
-    }
-
-
-    /**
-     * resets the DMSs, so we can attempt to continue migrating after a fatal error
-     * (only a good idea when someone has somehow tried ot fix whatever caused
-     * the fatal error in teh first place)
-     *
-     * @throws EE_Error
-     */
-    protected function _reattempt_migration()
-    {
-        $this->migration_manager->reattempt();
-        $this->_redirect_after_action(false, '', '', ['action' => 'default'], true);
-    }
-
-
-    /**
-     * shows the big ol' System Information page
-     *
-     * @throws EE_Error
-     */
-    public function _system_status()
-    {
-        $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_system_stati_page.template.php';
-        $this->_template_args['system_stati']               = EEM_System_Status::instance()->get_system_stati();
-        $this->_template_args['download_system_status_url'] = EE_Admin_Page::add_query_args_and_nonce(
-            [
-                'action' => 'download_system_status',
-            ],
-            EE_MAINTENANCE_ADMIN_URL
-        );
-        $this->_template_args['admin_page_content']         = EEH_Template::display_template(
-            $this->_template_path,
-            $this->_template_args,
-            true
-        );
-        $this->display_admin_page_with_no_sidebar();
-    }
-
-
-    /**
-     * Downloads an HTML file of the system status that can be easily stored or emailed
-     */
-    public function _download_system_status()
-    {
-        $status_info = EEM_System_Status::instance()->get_system_stati();
-        header('Content-Disposition: attachment');
-        header("Content-Disposition: attachment; filename=system_status_" . sanitize_key(site_url()) . ".html");
-        $output = '<style>table{border:1px solid darkgrey;}td{vertical-align:top}</style>';
-        $output .= '<h1>' . sprintf(
-            __('System Information for %1$s', 'event_espresso'),
-            esc_url_raw(site_url())
-        ) . '</h1>';
-        $output .= EEH_Template::layout_array_as_table($status_info);
-        echo esc_html($output);
-        die;
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    public function _send_migration_crash_report()
-    {
-        $from      = $this->_req_data['from'];
-        $from_name = $this->_req_data['from_name'];
-        $body      = $this->_req_data['body'];
-        try {
-            $success = wp_mail(
-                EE_SUPPORT_EMAIL,
-                'Migration Crash Report',
-                $body . "/r/n<br>" . print_r(EEM_System_Status::instance()->get_system_stati(), true),
-                [
-                    "from:$from_name<$from>",
-                ]
-            );
-        } catch (Exception $e) {
-            $success = false;
-        }
-        $this->_redirect_after_action(
-            $success,
-            esc_html__("Migration Crash Report", "event_espresso"),
-            esc_html__("sent", "event_espresso"),
-            ['success' => $success, 'action' => 'confirm_migration_crash_report_sent']
-        );
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    public function _confirm_migration_crash_report_sent()
-    {
-        try {
-            $most_recent_migration = $this->migration_manager->get_last_ran_script(true);
-        } catch (EE_Error $e) {
-            $this->migration_manager->add_error_to_migrations_ran($e->getMessage());
-            // now, just so we can display the page correctly, make an error migration script stage object
-            // and also put the error on it. It only persists for the duration of this request
-            $most_recent_migration = new EE_DMS_Unknown_1_0_0();
-            $most_recent_migration->add_error($e->getMessage());
-        }
-        $success                                       = $this->_req_data['success'] === '1';
-        $this->_template_args['success']               = $success;
-        $this->_template_args['most_recent_migration'] = $most_recent_migration;
-        $this->_template_args['reset_db_action_url']   = EE_Admin_Page::add_query_args_and_nonce(
-            ['action' => 'reset_db'],
-            EE_MAINTENANCE_ADMIN_URL
-        );
-        $this->_template_args['reset_db_page_url']     = EE_Admin_Page::add_query_args_and_nonce(
-            ['action' => 'data_reset'],
-            EE_MAINTENANCE_ADMIN_URL
-        );
-        $this->_template_args['reattempt_action_url']  = EE_Admin_Page::add_query_args_and_nonce(
-            ['action' => 'reattempt_migration'],
-            EE_MAINTENANCE_ADMIN_URL
-        );
-        $this->_template_path                          =
-            EE_MAINTENANCE_TEMPLATE_PATH . 'ee_confirm_migration_crash_report_sent.template.php';
-        $this->_template_args['admin_page_content']    = EEH_Template::display_template(
-            $this->_template_path,
-            $this->_template_args,
-            true
-        );
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * Resets the entire EE4 database.
-     * only sets up ee4 database for a fresh install-
-     * doesn't actually clean out the old wp options, or cpts
-     * (although it does erase old ee table data)
-     *
-     * @param boolean $nuke_old_ee4_data controls whether we destroy the old ee4 data,
-     *                                   or just try initializing ee4 default data
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function _reset_db($nuke_old_ee4_data = true)
-    {
-        $this->maintenance_mode->set_maintenance_level(EE_Maintenance_Mode::level_0_not_in_maintenance);
-        if ($nuke_old_ee4_data) {
-            EEH_Activation::delete_all_espresso_cpt_data();
-            EEH_Activation::delete_all_espresso_tables_and_data(false);
-            EEH_Activation::remove_cron_tasks();
-        }
-        // make sure when we reset the registry's config that it
-        // switches to using the new singleton
-        EE_Registry::instance()->CFG = EE_Registry::instance()->CFG->reset(true);
-        EE_System::instance()->initialize_db_if_no_migrations_required(true);
-        EE_System::instance()->redirect_to_about_ee();
-    }
-
-
-    /**
-     * Deletes ALL EE tables, Records, and Options from the database.
-     *
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function _delete_db()
-    {
-        $this->maintenance_mode->set_maintenance_level(EE_Maintenance_Mode::level_0_not_in_maintenance);
-        EEH_Activation::delete_all_espresso_cpt_data();
-        EEH_Activation::delete_all_espresso_tables_and_data();
-        EEH_Activation::remove_cron_tasks();
-        EEH_Activation::deactivate_event_espresso();
-        wp_safe_redirect(admin_url('plugins.php'));
-        exit;
-    }
-
-
-    /**
-     * sets up EE4 to rerun the migrations from ee3 to ee4
-     *
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function _rerun_migration_from_ee3()
-    {
-        $this->maintenance_mode->set_maintenance_level(EE_Maintenance_Mode::level_0_not_in_maintenance);
-        EEH_Activation::delete_all_espresso_cpt_data();
-        EEH_Activation::delete_all_espresso_tables_and_data(false);
-        // set the db state to something that will require migrations
-        update_option(EE_Data_Migration_Manager::current_database_state, '3.1.36.0');
-        $this->maintenance_mode->set_maintenance_level(EE_Maintenance_Mode::level_2_complete_maintenance);
-        $this->_redirect_after_action(
-            true,
-            esc_html__("Database", 'event_espresso'),
-            esc_html__("reset", 'event_espresso')
-        );
-    }
-
-
-    // none of the below group are currently used for Gateway Settings
-    protected function _add_screen_options()
-    {
-    }
-
-
-    protected function _add_feature_pointers()
-    {
-    }
-
-
-    public function admin_init()
-    {
-    }
-
-
-    public function admin_notices()
-    {
-    }
-
-
-    public function admin_footer_scripts()
-    {
-    }
-
-
-    public function load_scripts_styles()
-    {
-        wp_enqueue_script('ee_admin_js');
-        wp_enqueue_script(
-            'ee-maintenance',
-            EE_MAINTENANCE_ASSETS_URL . 'ee-maintenance.js',
-            ['jquery'],
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_register_style(
-            'espresso_maintenance',
-            EE_MAINTENANCE_ASSETS_URL . 'ee-maintenance.css',
-            [],
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('espresso_maintenance');
-        // localize script stuff
-        wp_localize_script(
-            'ee-maintenance',
-            'ee_maintenance',
-            [
-                'migrating'                        => wp_strip_all_tags(__("Updating Database...", "event_espresso")),
-                'next'                             => wp_strip_all_tags(__("Next", "event_espresso")),
-                'fatal_error'                      => wp_strip_all_tags(__(
-                    "A Fatal Error Has Occurred",
-                    "event_espresso"
-                )),
-                'click_next_when_ready'            => wp_strip_all_tags(
-                    __(
-                        "The current Database Update has ended. Click 'next' when ready to proceed",
-                        "event_espresso"
-                    )
-                ),
-                'status_no_more_migration_scripts' => EE_Data_Migration_Manager::status_no_more_migration_scripts,
-                'status_fatal_error'               => EE_Data_Migration_Manager::status_fatal_error,
-                'status_completed'                 => EE_Data_Migration_Manager::status_completed,
-                'confirm'                          => wp_strip_all_tags(
-                    __(
-                        'Are you sure you want to do this? It CANNOT be undone!',
-                        'event_espresso'
-                    )
-                ),
-                'confirm_skip_migration'           => wp_strip_all_tags(
-                    __(
-                        'You have chosen to NOT migrate your existing data. Are you sure you want to continue?',
-                        'event_espresso'
-                    )
-                ),
-            ]
-        );
-    }
-
-
-    public function load_scripts_styles_default()
-    {
-    }
-
-
-    /**
-     * Enqueue scripts and styles for the datetime tools page.
-     */
-    public function load_scripts_styles_datetime_tools()
-    {
-        EE_Datepicker_Input::enqueue_styles_and_scripts();
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    protected function _datetime_tools()
-    {
-        $form_action                                = EE_Admin_Page::add_query_args_and_nonce(
-            [
-                'action'        => 'run_datetime_offset_fix',
-                'return_action' => $this->_req_action,
-            ],
-            EE_MAINTENANCE_ADMIN_URL
-        );
-        $form                                       = $this->_get_datetime_offset_fix_form();
-        $this->_admin_page_title                    = esc_html__('Datetime Utilities', 'event_espresso');
-        $this->_template_args['admin_page_content'] = $form->form_open($form_action, 'post')
-                                                      . $form->get_html_and_js()
-                                                      . $form->form_close();
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    protected function _get_datetime_offset_fix_form()
-    {
-        if (! $this->datetime_fix_offset_form instanceof EE_Form_Section_Proper) {
-            $this->datetime_fix_offset_form = new EE_Form_Section_Proper(
-                [
-                    'name'            => 'datetime_offset_fix_option',
-                    'layout_strategy' => new EE_Admin_Two_Column_Layout(),
-                    'subsections'     => [
-                        'title'                  => new EE_Form_Section_HTML(
-                            EEH_HTML::h2(
-                                esc_html__('Datetime Offset Tool', 'event_espresso')
-                            )
-                        ),
-                        'explanation'            => new EE_Form_Section_HTML(
-                            EEH_HTML::p(
-                                esc_html__(
-                                    'Use this tool to automatically apply the provided offset to all Event Espresso records in your database that involve dates and times.',
-                                    'event_espresso'
-                                )
-                            )
-                            . EEH_HTML::p(
-                                esc_html__(
-                                    'Note: If you enter 1.25, that will result in the offset of 1 hour 15 minutes being applied.  Decimals represent the fraction of hours, not minutes.',
-                                    'event_espresso'
-                                )
-                            )
-                        ),
-                        'offset_input'           => new EE_Float_Input(
-                            [
-                                'html_name'       => 'offset_for_datetimes',
-                                'html_label_text' => esc_html__(
-                                    'Offset to apply (in hours):',
-                                    'event_espresso'
-                                ),
-                                'min_value'       => '-12',
-                                'max_value'       => '14',
-                                'step_value'      => '.25',
-                                'default'         => DatetimeOffsetFix::getOffset(),
-                            ]
-                        ),
-                        'date_range_explanation' => new EE_Form_Section_HTML(
-                            EEH_HTML::p(
-                                esc_html__(
-                                    'Leave the following fields blank if you want the offset to be applied to all dates. If however, you want to just apply the offset to a specific range of dates you can restrict the offset application using these fields.',
-                                    'event_espresso'
-                                )
-                            )
-                            . EEH_HTML::p(
-                                EEH_HTML::strong(
-                                    sprintf(
-                                        esc_html__(
-                                            'Note: please enter the dates in UTC (You can use %1$sthis online tool%2$s to assist with conversions).',
-                                            'event_espresso'
-                                        ),
-                                        '<a href="https://www.timeanddate.com/worldclock/converter.html">',
-                                        '</a>'
-                                    )
-                                )
-                            )
-                        ),
-                        'date_range_start_date'  => new EE_Datepicker_Input(
-                            [
-                                'html_name'       => 'offset_date_start_range',
-                                'html_label_text' => esc_html__(
-                                    'Start Date for dates the offset applied to:',
-                                    'event_espresso'
-                                ),
-                            ]
-                        ),
-                        'date_range_end_date'    => new EE_Datepicker_Input(
-                            [
-                                'html_name'       => 'offset_date_end_range',
-                                'html_label_text' => esc_html__(
-                                    'End Date for dates the offset is applied to:',
-                                    'event_espresso'
-                                ),
-                            ]
-                        ),
-                        'submit'                 => new EE_Submit_Input(
-                            [
-                                'html_label_text' => '',
-                                'default'         => esc_html__('Apply Offset', 'event_espresso'),
-                            ]
-                        ),
-                    ],
-                ]
-            );
-        }
-        return $this->datetime_fix_offset_form;
-    }
-
-
-    /**
-     * Callback for the run_datetime_offset_fix route.
-     *
-     * @throws EE_Error
-     */
-    protected function _apply_datetime_offset()
-    {
-        if ($_SERVER['REQUEST_METHOD'] === 'POST') {
-            $form = $this->_get_datetime_offset_fix_form();
-            $form->receive_form_submission($this->_req_data);
-            if ($form->is_valid()) {
-                // save offset data so batch processor can get it.
-                DatetimeOffsetFix::updateOffset($form->get_input_value('offset_input'));
-                $utc_timezone          = new DateTimeZone('UTC');
-                $date_range_start_date = DateTime::createFromFormat(
-                    'm/d/Y H:i:s',
-                    $form->get_input_value('date_range_start_date') . ' 00:00:00',
-                    $utc_timezone
-                );
-                $date_range_end_date   = DateTime::createFromFormat(
-                    'm/d/Y H:i:s',
-                    $form->get_input_value('date_range_end_date') . ' 23:59:59',
-                    $utc_timezone
-                );
-                if ($date_range_start_date instanceof DateTime) {
-                    DatetimeOffsetFix::updateStartDateRange(DbSafeDateTime::createFromDateTime($date_range_start_date));
-                }
-                if ($date_range_end_date instanceof DateTime) {
-                    DatetimeOffsetFix::updateEndDateRange(DbSafeDateTime::createFromDateTime($date_range_end_date));
-                }
-                // redirect to batch tool
-                wp_redirect(
-                    EE_Admin_Page::add_query_args_and_nonce(
-                        [
-                            'page'        => EED_Batch::PAGE_SLUG,
-                            'batch'       => EED_Batch::batch_job,
-                            'label'       => esc_html__('Applying Offset', 'event_espresso'),
-                            'job_handler' => urlencode('EventEspressoBatchRequest\JobHandlers\DatetimeOffsetFix'),
-                            'return_url'  => urlencode(
-                                add_query_arg(
-                                    [
-                                        'action' => 'datetime_tools',
-                                    ],
-                                    EEH_URL::current_url_without_query_paramaters(
-                                        [
-                                            'return_action',
-                                            'run_datetime_offset_fix_nonce',
-                                            'return',
-                                            'datetime_tools_nonce',
-                                        ]
-                                    )
-                                )
-                            ),
-                        ],
-                        admin_url()
-                    )
-                );
-                exit;
-            }
-        }
-    }
+	/**
+	 * @var EE_Data_Migration_Manager
+	 */
+	protected $migration_manager;
+
+	/**
+	 * @var EE_Maintenance_Mode
+	 */
+	protected $maintenance_mode;
+
+	/**
+	 * @var EE_Form_Section_Proper
+	 */
+	protected $datetime_fix_offset_form;
+
+
+	/**
+	 * @param bool $routing
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function __construct($routing = true)
+	{
+		$this->migration_manager = EE_Data_Migration_Manager::instance();
+		$this->maintenance_mode  = EE_Maintenance_Mode::instance();
+		parent::__construct($routing);
+	}
+
+
+	protected function _init_page_props()
+	{
+		$this->page_slug        = EE_MAINTENANCE_PG_SLUG;
+		$this->page_label       = EE_MAINTENANCE_LABEL;
+		$this->_admin_base_url  = EE_MAINTENANCE_ADMIN_URL;
+		$this->_admin_base_path = EE_MAINTENANCE_ADMIN;
+	}
+
+
+	protected function _ajax_hooks()
+	{
+		add_action('wp_ajax_migration_step', [$this, 'migration_step']);
+		add_action('wp_ajax_add_error_to_migrations_ran', [$this, 'add_error_to_migrations_ran']);
+	}
+
+
+	protected function _define_page_props()
+	{
+		$this->_admin_page_title = EE_MAINTENANCE_LABEL;
+		$this->_labels           = [
+			'buttons' => [
+				'reset_reservations' => esc_html__('Reset Ticket and Datetime Reserved Counts', 'event_espresso'),
+				'reset_capabilities' => esc_html__('Reset Event Espresso Capabilities', 'event_espresso'),
+			],
+		];
+	}
+
+
+	protected function _set_page_routes()
+	{
+		$this->_page_routes = [
+			'default'                             => [
+				'func'       => '_maintenance',
+				'capability' => 'manage_options',
+			],
+			'change_maintenance_level'            => [
+				'func'       => '_change_maintenance_level',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			],
+			'system_status'                       => [
+				'func'       => '_system_status',
+				'capability' => 'manage_options',
+			],
+			'download_system_status'              => [
+				'func'       => '_download_system_status',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			],
+			'send_migration_crash_report'         => [
+				'func'       => '_send_migration_crash_report',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			],
+			'confirm_migration_crash_report_sent' => [
+				'func'       => '_confirm_migration_crash_report_sent',
+				'capability' => 'manage_options',
+			],
+			'data_reset'                          => [
+				'func'       => '_data_reset_and_delete',
+				'capability' => 'manage_options',
+			],
+			'reset_db'                            => [
+				'func'       => '_reset_db',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+				'args'       => ['nuke_old_ee4_data' => true],
+			],
+			'start_with_fresh_ee4_db'             => [
+				'func'       => '_reset_db',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+				'args'       => ['nuke_old_ee4_data' => false],
+			],
+			'delete_db'                           => [
+				'func'       => '_delete_db',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			],
+			'rerun_migration_from_ee3'            => [
+				'func'       => '_rerun_migration_from_ee3',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			],
+			'reset_reservations'                  => [
+				'func'       => '_reset_reservations',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			],
+			'reset_capabilities'                  => [
+				'func'       => '_reset_capabilities',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			],
+			'reattempt_migration'                 => [
+				'func'       => '_reattempt_migration',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			],
+			'datetime_tools'                      => [
+				'func'       => '_datetime_tools',
+				'capability' => 'manage_options',
+			],
+			'run_datetime_offset_fix'             => [
+				'func'               => '_apply_datetime_offset',
+				'noheader'           => true,
+				'headers_sent_route' => 'datetime_tools',
+				'capability'         => 'manage_options',
+			],
+		];
+	}
+
+
+	protected function _set_page_config()
+	{
+		$this->_page_config = [
+			'default'        => [
+				'nav'           => [
+					'label' => esc_html__('Maintenance', 'event_espresso'),
+					'icon' => 'dashicons-admin-tools',
+					'order' => 10,
+				],
+				'require_nonce' => false,
+			],
+			'data_reset'     => [
+				'nav'           => [
+					'label' => esc_html__('Reset/Delete Data', 'event_espresso'),
+					'icon' => 'dashicons-trash',
+					'order' => 20,
+				],
+				'require_nonce' => false,
+			],
+			'datetime_tools' => [
+				'nav'           => [
+					'label' => esc_html__('Datetime Utilities', 'event_espresso'),
+					'icon' => 'dashicons-calendar-alt',
+					'order' => 25,
+				],
+				'require_nonce' => false,
+			],
+			'system_status'  => [
+				'nav'           => [
+					'label' => esc_html__("System Information", "event_espresso"),
+					'icon' => 'dashicons-info',
+					'order' => 30,
+				],
+				'require_nonce' => false,
+			],
+		];
+	}
+
+
+	/**
+	 * default maintenance page.
+	 * If we're in maintenance mode level 2, then we need to show the migration scripts and all that UI.
+	 *
+	 * @throws EE_Error
+	 */
+	public function _maintenance()
+	{
+		$show_maintenance_switch         = true;
+		$show_backup_db_text             = false;
+		$show_migration_progress         = false;
+		$script_names                    = [];
+		$addons_should_be_upgraded_first = false;
+		// it all depends on if we're in maintenance model level 1 (frontend-only) or
+		// level 2 (everything except maintenance page)
+		try {
+			// get the current maintenance level and check if
+			// we are removed
+			$mMode_level  = $this->maintenance_mode->level();
+			$placed_in_mm = $this->maintenance_mode->set_maintenance_mode_if_db_old();
+			if ($mMode_level == EE_Maintenance_Mode::level_2_complete_maintenance && ! $placed_in_mm) {
+				// we just took the site out of maintenance mode, so notify the user.
+				// unfortunately this message appears to be echoed on the NEXT page load...
+				// oh well, we should really be checking for this on addon deactivation anyways
+				EE_Error::add_attention(
+					esc_html__(
+						'Site taken out of maintenance mode because no data migration scripts are required',
+						'event_espresso'
+					)
+				);
+				$this->_process_notices(['page' => 'espresso_maintenance_settings']);
+			}
+			// in case an exception is thrown while trying to handle migrations
+			if ($mMode_level === EE_Maintenance_Mode::level_2_complete_maintenance) {
+				$show_maintenance_switch = false;
+				$show_migration_progress = true;
+				if (isset($this->_req_data['continue_migration'])) {
+					$show_backup_db_text = false;
+				} else {
+					$show_backup_db_text = true;
+				}
+				$scripts_needing_to_run          =
+					$this->migration_manager->check_for_applicable_data_migration_scripts();
+				$addons_should_be_upgraded_first = $this->migration_manager->addons_need_updating();
+				$script_names                    = [];
+				$current_script                  = null;
+				foreach ($scripts_needing_to_run as $script) {
+					if ($script instanceof EE_Data_Migration_Script_Base) {
+						if (! $current_script) {
+							$current_script = $script;
+							$current_script->migration_page_hooks();
+						}
+						$script_names[] = $script->pretty_name();
+					}
+				}
+			}
+			$most_recent_migration = $this->migration_manager->get_last_ran_script(true);
+			$exception_thrown      = false;
+		} catch (EE_Error $e) {
+			$this->migration_manager->add_error_to_migrations_ran($e->getMessage());
+			// now, just so we can display the page correctly, make an error migration script stage object
+			// and also put the error on it. It only persists for the duration of this request
+			$most_recent_migration = new EE_DMS_Unknown_1_0_0();
+			$most_recent_migration->add_error($e->getMessage());
+			$exception_thrown = true;
+		}
+		$current_db_state = $this->migration_manager->ensure_current_database_state_is_set();
+		$current_db_state = str_replace('.decaf', '', $current_db_state);
+		if (
+			$exception_thrown
+			|| (
+				$most_recent_migration instanceof EE_Data_Migration_Script_Base
+				&& $most_recent_migration->is_broken()
+			)
+		) {
+			$this->_template_path                =
+				EE_MAINTENANCE_TEMPLATE_PATH . 'ee_migration_was_borked_page.template.php';
+			$this->_template_args['support_url'] = 'https://eventespresso.com/support/forums/';
+			$this->_template_args['next_url']    = EEH_URL::add_query_args_and_nonce(
+				[
+					'action'  => 'confirm_migration_crash_report_sent',
+					'success' => '0',
+				],
+				EE_MAINTENANCE_ADMIN_URL
+			);
+		} elseif ($addons_should_be_upgraded_first) {
+			$this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_upgrade_addons_before_migrating.template.php';
+		} else {
+			if (
+				$most_recent_migration instanceof EE_Data_Migration_Script_Base
+				&& $most_recent_migration->can_continue()
+			) {
+				$show_backup_db_text                    = false;
+				$show_continue_current_migration_script = true;
+				$show_most_recent_migration             = true;
+			} elseif (isset($this->_req_data['continue_migration'])) {
+				$show_most_recent_migration             = true;
+				$show_continue_current_migration_script = false;
+			} else {
+				$show_most_recent_migration             = false;
+				$show_continue_current_migration_script = false;
+			}
+			if (isset($current_script)) {
+				$migrates_to          = $current_script->migrates_to_version();
+				$plugin_slug          = $migrates_to['slug'];
+				$new_version          = $migrates_to['version'];
+				$this->_template_args = array_merge(
+					$this->_template_args,
+					[
+						'current_db_state' => sprintf(
+							esc_html__("EE%s (%s)", "event_espresso"),
+							isset($current_db_state[ $plugin_slug ]) ? $current_db_state[ $plugin_slug ] : 3,
+							$plugin_slug
+						),
+						'next_db_state'    => sprintf(
+							esc_html__("EE%s (%s)", 'event_espresso'),
+							$new_version,
+							$plugin_slug
+						),
+					]
+				);
+			} else {
+				$this->_template_args['current_db_state'] = null;
+				$this->_template_args['next_db_state']    = null;
+			}
+			$this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_migration_page.template.php';
+			$this->_template_args = array_merge(
+				$this->_template_args,
+				[
+					'show_most_recent_migration'             => $show_most_recent_migration,
+					// flag for showing the most recent migration's status and/or errors
+					'show_migration_progress'                => $show_migration_progress,
+					// flag for showing the option to run migrations and see their progress
+					'show_backup_db_text'                    => $show_backup_db_text,
+					// flag for showing text telling the user to back up their DB
+					'show_maintenance_switch'                => $show_maintenance_switch,
+					// flag for showing the option to change maintenance mode between levels 0 and 1
+					'script_names'                           => $script_names,
+					// array of names of scripts that have run
+					'show_continue_current_migration_script' => $show_continue_current_migration_script,
+					// flag to change wording to indicating that we're only CONTINUING a migration script (somehow it got interrupted0
+					'reset_db_page_link'                     => EE_Admin_Page::add_query_args_and_nonce(
+						['action' => 'reset_db'],
+						EE_MAINTENANCE_ADMIN_URL
+					),
+					'data_reset_page'                        => EE_Admin_Page::add_query_args_and_nonce(
+						['action' => 'data_reset'],
+						EE_MAINTENANCE_ADMIN_URL
+					),
+					'update_migration_script_page_link'      => EE_Admin_Page::add_query_args_and_nonce(
+						['action' => 'change_maintenance_level'],
+						EE_MAINTENANCE_ADMIN_URL
+					),
+					'ultimate_db_state'                      => sprintf(
+						esc_html__("EE%s", 'event_espresso'),
+						espresso_version()
+					),
+				]
+			);
+		}
+		$this->_template_args['most_recent_migration'] =
+			$most_recent_migration;// the actual most recently ran migration
+		// now render the migration options part, and put it in a variable
+		$migration_options_template_file                = apply_filters(
+			'FHEE__ee_migration_page__migration_options_template',
+			EE_MAINTENANCE_TEMPLATE_PATH . 'migration_options_from_ee4.template.php'
+		);
+		$migration_options_html                         = EEH_Template::display_template(
+			$migration_options_template_file,
+			$this->_template_args,
+			true
+		);
+		$this->_template_args['migration_options_html'] = $migration_options_html;
+		$this->_template_args['admin_page_content']     = EEH_Template::display_template(
+			$this->_template_path,
+			$this->_template_args,
+			true
+		);
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * returns JSON and executes another step of the currently-executing data migration (called via ajax)
+	 *
+	 * @throws EE_Error
+	 */
+	public function migration_step()
+	{
+		$this->_template_args['data'] = $this->migration_manager->response_to_migration_ajax_request();
+		$this->_return_json();
+	}
+
+
+	/**
+	 * Can be used by js when it notices a response with HTML in it in order
+	 * to log the malformed response
+	 *
+	 * @throws EE_Error
+	 */
+	public function add_error_to_migrations_ran()
+	{
+		$this->migration_manager->add_error_to_migrations_ran($this->_req_data['message']);
+		$this->_template_args['data'] = ['ok' => true];
+		$this->_return_json();
+	}
+
+
+	/**
+	 * changes the maintenance level, provided there are still no migration scripts that should run
+	 *
+	 * @throws EE_Error
+	 */
+	public function _change_maintenance_level()
+	{
+		$new_level = absint($this->_req_data['maintenance_mode_level']);
+		if (! $this->migration_manager->check_for_applicable_data_migration_scripts()) {
+			$this->maintenance_mode->set_maintenance_level($new_level);
+			$success = true;
+		} else {
+			$this->maintenance_mode->set_maintenance_mode_if_db_old();
+			$success = false;
+		}
+		$this->_redirect_after_action($success, 'Maintenance Mode', esc_html__("Updated", "event_espresso"));
+	}
+
+
+	/**
+	 * a tab with options for resetting and/or deleting EE data
+	 *
+	 * @throws EE_Error
+	 * @throws DomainException
+	 */
+	public function _data_reset_and_delete()
+	{
+		$this->_template_path                              =
+			EE_MAINTENANCE_TEMPLATE_PATH . 'ee_data_reset_and_delete.template.php';
+		$this->_template_args['reset_reservations_button'] = $this->get_action_link_or_button(
+			'reset_reservations',
+			'reset_reservations',
+			[],
+			'button button--caution ee-confirm'
+		);
+		$this->_template_args['reset_capabilities_button'] = $this->get_action_link_or_button(
+			'reset_capabilities',
+			'reset_capabilities',
+			[],
+			'button button--caution ee-confirm'
+		);
+		$this->_template_args['delete_db_url']             = EE_Admin_Page::add_query_args_and_nonce(
+			['action' => 'delete_db'],
+			EE_MAINTENANCE_ADMIN_URL
+		);
+		$this->_template_args['reset_db_url']              = EE_Admin_Page::add_query_args_and_nonce(
+			['action' => 'reset_db'],
+			EE_MAINTENANCE_ADMIN_URL
+		);
+		$this->_template_args['admin_page_content']        = EEH_Template::display_template(
+			$this->_template_path,
+			$this->_template_args,
+			true
+		);
+		$this->display_admin_page_with_no_sidebar();
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _reset_reservations()
+	{
+		if (EED_Ticket_Sales_Monitor::reset_reservation_counts()) {
+			EE_Error::add_success(
+				esc_html__(
+					'Ticket and datetime reserved counts have been successfully reset.',
+					'event_espresso'
+				)
+			);
+		} else {
+			EE_Error::add_success(
+				esc_html__(
+					'Ticket and datetime reserved counts were correct and did not need resetting.',
+					'event_espresso'
+				)
+			);
+		}
+		$this->_redirect_after_action(true, '', '', ['action' => 'data_reset'], true);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	protected function _reset_capabilities()
+	{
+		EE_Registry::instance()->CAP->init_caps(true);
+		EE_Error::add_success(
+			esc_html__(
+				'Default Event Espresso capabilities have been restored for all current roles.',
+				'event_espresso'
+			)
+		);
+		$this->_redirect_after_action(false, '', '', ['action' => 'data_reset'], true);
+	}
+
+
+	/**
+	 * resets the DMSs, so we can attempt to continue migrating after a fatal error
+	 * (only a good idea when someone has somehow tried ot fix whatever caused
+	 * the fatal error in teh first place)
+	 *
+	 * @throws EE_Error
+	 */
+	protected function _reattempt_migration()
+	{
+		$this->migration_manager->reattempt();
+		$this->_redirect_after_action(false, '', '', ['action' => 'default'], true);
+	}
+
+
+	/**
+	 * shows the big ol' System Information page
+	 *
+	 * @throws EE_Error
+	 */
+	public function _system_status()
+	{
+		$this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_system_stati_page.template.php';
+		$this->_template_args['system_stati']               = EEM_System_Status::instance()->get_system_stati();
+		$this->_template_args['download_system_status_url'] = EE_Admin_Page::add_query_args_and_nonce(
+			[
+				'action' => 'download_system_status',
+			],
+			EE_MAINTENANCE_ADMIN_URL
+		);
+		$this->_template_args['admin_page_content']         = EEH_Template::display_template(
+			$this->_template_path,
+			$this->_template_args,
+			true
+		);
+		$this->display_admin_page_with_no_sidebar();
+	}
+
+
+	/**
+	 * Downloads an HTML file of the system status that can be easily stored or emailed
+	 */
+	public function _download_system_status()
+	{
+		$status_info = EEM_System_Status::instance()->get_system_stati();
+		header('Content-Disposition: attachment');
+		header("Content-Disposition: attachment; filename=system_status_" . sanitize_key(site_url()) . ".html");
+		$output = '<style>table{border:1px solid darkgrey;}td{vertical-align:top}</style>';
+		$output .= '<h1>' . sprintf(
+			__('System Information for %1$s', 'event_espresso'),
+			esc_url_raw(site_url())
+		) . '</h1>';
+		$output .= EEH_Template::layout_array_as_table($status_info);
+		echo esc_html($output);
+		die;
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	public function _send_migration_crash_report()
+	{
+		$from      = $this->_req_data['from'];
+		$from_name = $this->_req_data['from_name'];
+		$body      = $this->_req_data['body'];
+		try {
+			$success = wp_mail(
+				EE_SUPPORT_EMAIL,
+				'Migration Crash Report',
+				$body . "/r/n<br>" . print_r(EEM_System_Status::instance()->get_system_stati(), true),
+				[
+					"from:$from_name<$from>",
+				]
+			);
+		} catch (Exception $e) {
+			$success = false;
+		}
+		$this->_redirect_after_action(
+			$success,
+			esc_html__("Migration Crash Report", "event_espresso"),
+			esc_html__("sent", "event_espresso"),
+			['success' => $success, 'action' => 'confirm_migration_crash_report_sent']
+		);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	public function _confirm_migration_crash_report_sent()
+	{
+		try {
+			$most_recent_migration = $this->migration_manager->get_last_ran_script(true);
+		} catch (EE_Error $e) {
+			$this->migration_manager->add_error_to_migrations_ran($e->getMessage());
+			// now, just so we can display the page correctly, make an error migration script stage object
+			// and also put the error on it. It only persists for the duration of this request
+			$most_recent_migration = new EE_DMS_Unknown_1_0_0();
+			$most_recent_migration->add_error($e->getMessage());
+		}
+		$success                                       = $this->_req_data['success'] === '1';
+		$this->_template_args['success']               = $success;
+		$this->_template_args['most_recent_migration'] = $most_recent_migration;
+		$this->_template_args['reset_db_action_url']   = EE_Admin_Page::add_query_args_and_nonce(
+			['action' => 'reset_db'],
+			EE_MAINTENANCE_ADMIN_URL
+		);
+		$this->_template_args['reset_db_page_url']     = EE_Admin_Page::add_query_args_and_nonce(
+			['action' => 'data_reset'],
+			EE_MAINTENANCE_ADMIN_URL
+		);
+		$this->_template_args['reattempt_action_url']  = EE_Admin_Page::add_query_args_and_nonce(
+			['action' => 'reattempt_migration'],
+			EE_MAINTENANCE_ADMIN_URL
+		);
+		$this->_template_path                          =
+			EE_MAINTENANCE_TEMPLATE_PATH . 'ee_confirm_migration_crash_report_sent.template.php';
+		$this->_template_args['admin_page_content']    = EEH_Template::display_template(
+			$this->_template_path,
+			$this->_template_args,
+			true
+		);
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * Resets the entire EE4 database.
+	 * only sets up ee4 database for a fresh install-
+	 * doesn't actually clean out the old wp options, or cpts
+	 * (although it does erase old ee table data)
+	 *
+	 * @param boolean $nuke_old_ee4_data controls whether we destroy the old ee4 data,
+	 *                                   or just try initializing ee4 default data
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function _reset_db($nuke_old_ee4_data = true)
+	{
+		$this->maintenance_mode->set_maintenance_level(EE_Maintenance_Mode::level_0_not_in_maintenance);
+		if ($nuke_old_ee4_data) {
+			EEH_Activation::delete_all_espresso_cpt_data();
+			EEH_Activation::delete_all_espresso_tables_and_data(false);
+			EEH_Activation::remove_cron_tasks();
+		}
+		// make sure when we reset the registry's config that it
+		// switches to using the new singleton
+		EE_Registry::instance()->CFG = EE_Registry::instance()->CFG->reset(true);
+		EE_System::instance()->initialize_db_if_no_migrations_required(true);
+		EE_System::instance()->redirect_to_about_ee();
+	}
+
+
+	/**
+	 * Deletes ALL EE tables, Records, and Options from the database.
+	 *
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function _delete_db()
+	{
+		$this->maintenance_mode->set_maintenance_level(EE_Maintenance_Mode::level_0_not_in_maintenance);
+		EEH_Activation::delete_all_espresso_cpt_data();
+		EEH_Activation::delete_all_espresso_tables_and_data();
+		EEH_Activation::remove_cron_tasks();
+		EEH_Activation::deactivate_event_espresso();
+		wp_safe_redirect(admin_url('plugins.php'));
+		exit;
+	}
+
+
+	/**
+	 * sets up EE4 to rerun the migrations from ee3 to ee4
+	 *
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function _rerun_migration_from_ee3()
+	{
+		$this->maintenance_mode->set_maintenance_level(EE_Maintenance_Mode::level_0_not_in_maintenance);
+		EEH_Activation::delete_all_espresso_cpt_data();
+		EEH_Activation::delete_all_espresso_tables_and_data(false);
+		// set the db state to something that will require migrations
+		update_option(EE_Data_Migration_Manager::current_database_state, '3.1.36.0');
+		$this->maintenance_mode->set_maintenance_level(EE_Maintenance_Mode::level_2_complete_maintenance);
+		$this->_redirect_after_action(
+			true,
+			esc_html__("Database", 'event_espresso'),
+			esc_html__("reset", 'event_espresso')
+		);
+	}
+
+
+	// none of the below group are currently used for Gateway Settings
+	protected function _add_screen_options()
+	{
+	}
+
+
+	protected function _add_feature_pointers()
+	{
+	}
+
+
+	public function admin_init()
+	{
+	}
+
+
+	public function admin_notices()
+	{
+	}
+
+
+	public function admin_footer_scripts()
+	{
+	}
+
+
+	public function load_scripts_styles()
+	{
+		wp_enqueue_script('ee_admin_js');
+		wp_enqueue_script(
+			'ee-maintenance',
+			EE_MAINTENANCE_ASSETS_URL . 'ee-maintenance.js',
+			['jquery'],
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_register_style(
+			'espresso_maintenance',
+			EE_MAINTENANCE_ASSETS_URL . 'ee-maintenance.css',
+			[],
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('espresso_maintenance');
+		// localize script stuff
+		wp_localize_script(
+			'ee-maintenance',
+			'ee_maintenance',
+			[
+				'migrating'                        => wp_strip_all_tags(__("Updating Database...", "event_espresso")),
+				'next'                             => wp_strip_all_tags(__("Next", "event_espresso")),
+				'fatal_error'                      => wp_strip_all_tags(__(
+					"A Fatal Error Has Occurred",
+					"event_espresso"
+				)),
+				'click_next_when_ready'            => wp_strip_all_tags(
+					__(
+						"The current Database Update has ended. Click 'next' when ready to proceed",
+						"event_espresso"
+					)
+				),
+				'status_no_more_migration_scripts' => EE_Data_Migration_Manager::status_no_more_migration_scripts,
+				'status_fatal_error'               => EE_Data_Migration_Manager::status_fatal_error,
+				'status_completed'                 => EE_Data_Migration_Manager::status_completed,
+				'confirm'                          => wp_strip_all_tags(
+					__(
+						'Are you sure you want to do this? It CANNOT be undone!',
+						'event_espresso'
+					)
+				),
+				'confirm_skip_migration'           => wp_strip_all_tags(
+					__(
+						'You have chosen to NOT migrate your existing data. Are you sure you want to continue?',
+						'event_espresso'
+					)
+				),
+			]
+		);
+	}
+
+
+	public function load_scripts_styles_default()
+	{
+	}
+
+
+	/**
+	 * Enqueue scripts and styles for the datetime tools page.
+	 */
+	public function load_scripts_styles_datetime_tools()
+	{
+		EE_Datepicker_Input::enqueue_styles_and_scripts();
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	protected function _datetime_tools()
+	{
+		$form_action                                = EE_Admin_Page::add_query_args_and_nonce(
+			[
+				'action'        => 'run_datetime_offset_fix',
+				'return_action' => $this->_req_action,
+			],
+			EE_MAINTENANCE_ADMIN_URL
+		);
+		$form                                       = $this->_get_datetime_offset_fix_form();
+		$this->_admin_page_title                    = esc_html__('Datetime Utilities', 'event_espresso');
+		$this->_template_args['admin_page_content'] = $form->form_open($form_action, 'post')
+													  . $form->get_html_and_js()
+													  . $form->form_close();
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	protected function _get_datetime_offset_fix_form()
+	{
+		if (! $this->datetime_fix_offset_form instanceof EE_Form_Section_Proper) {
+			$this->datetime_fix_offset_form = new EE_Form_Section_Proper(
+				[
+					'name'            => 'datetime_offset_fix_option',
+					'layout_strategy' => new EE_Admin_Two_Column_Layout(),
+					'subsections'     => [
+						'title'                  => new EE_Form_Section_HTML(
+							EEH_HTML::h2(
+								esc_html__('Datetime Offset Tool', 'event_espresso')
+							)
+						),
+						'explanation'            => new EE_Form_Section_HTML(
+							EEH_HTML::p(
+								esc_html__(
+									'Use this tool to automatically apply the provided offset to all Event Espresso records in your database that involve dates and times.',
+									'event_espresso'
+								)
+							)
+							. EEH_HTML::p(
+								esc_html__(
+									'Note: If you enter 1.25, that will result in the offset of 1 hour 15 minutes being applied.  Decimals represent the fraction of hours, not minutes.',
+									'event_espresso'
+								)
+							)
+						),
+						'offset_input'           => new EE_Float_Input(
+							[
+								'html_name'       => 'offset_for_datetimes',
+								'html_label_text' => esc_html__(
+									'Offset to apply (in hours):',
+									'event_espresso'
+								),
+								'min_value'       => '-12',
+								'max_value'       => '14',
+								'step_value'      => '.25',
+								'default'         => DatetimeOffsetFix::getOffset(),
+							]
+						),
+						'date_range_explanation' => new EE_Form_Section_HTML(
+							EEH_HTML::p(
+								esc_html__(
+									'Leave the following fields blank if you want the offset to be applied to all dates. If however, you want to just apply the offset to a specific range of dates you can restrict the offset application using these fields.',
+									'event_espresso'
+								)
+							)
+							. EEH_HTML::p(
+								EEH_HTML::strong(
+									sprintf(
+										esc_html__(
+											'Note: please enter the dates in UTC (You can use %1$sthis online tool%2$s to assist with conversions).',
+											'event_espresso'
+										),
+										'<a href="https://www.timeanddate.com/worldclock/converter.html">',
+										'</a>'
+									)
+								)
+							)
+						),
+						'date_range_start_date'  => new EE_Datepicker_Input(
+							[
+								'html_name'       => 'offset_date_start_range',
+								'html_label_text' => esc_html__(
+									'Start Date for dates the offset applied to:',
+									'event_espresso'
+								),
+							]
+						),
+						'date_range_end_date'    => new EE_Datepicker_Input(
+							[
+								'html_name'       => 'offset_date_end_range',
+								'html_label_text' => esc_html__(
+									'End Date for dates the offset is applied to:',
+									'event_espresso'
+								),
+							]
+						),
+						'submit'                 => new EE_Submit_Input(
+							[
+								'html_label_text' => '',
+								'default'         => esc_html__('Apply Offset', 'event_espresso'),
+							]
+						),
+					],
+				]
+			);
+		}
+		return $this->datetime_fix_offset_form;
+	}
+
+
+	/**
+	 * Callback for the run_datetime_offset_fix route.
+	 *
+	 * @throws EE_Error
+	 */
+	protected function _apply_datetime_offset()
+	{
+		if ($_SERVER['REQUEST_METHOD'] === 'POST') {
+			$form = $this->_get_datetime_offset_fix_form();
+			$form->receive_form_submission($this->_req_data);
+			if ($form->is_valid()) {
+				// save offset data so batch processor can get it.
+				DatetimeOffsetFix::updateOffset($form->get_input_value('offset_input'));
+				$utc_timezone          = new DateTimeZone('UTC');
+				$date_range_start_date = DateTime::createFromFormat(
+					'm/d/Y H:i:s',
+					$form->get_input_value('date_range_start_date') . ' 00:00:00',
+					$utc_timezone
+				);
+				$date_range_end_date   = DateTime::createFromFormat(
+					'm/d/Y H:i:s',
+					$form->get_input_value('date_range_end_date') . ' 23:59:59',
+					$utc_timezone
+				);
+				if ($date_range_start_date instanceof DateTime) {
+					DatetimeOffsetFix::updateStartDateRange(DbSafeDateTime::createFromDateTime($date_range_start_date));
+				}
+				if ($date_range_end_date instanceof DateTime) {
+					DatetimeOffsetFix::updateEndDateRange(DbSafeDateTime::createFromDateTime($date_range_end_date));
+				}
+				// redirect to batch tool
+				wp_redirect(
+					EE_Admin_Page::add_query_args_and_nonce(
+						[
+							'page'        => EED_Batch::PAGE_SLUG,
+							'batch'       => EED_Batch::batch_job,
+							'label'       => esc_html__('Applying Offset', 'event_espresso'),
+							'job_handler' => urlencode('EventEspressoBatchRequest\JobHandlers\DatetimeOffsetFix'),
+							'return_url'  => urlencode(
+								add_query_arg(
+									[
+										'action' => 'datetime_tools',
+									],
+									EEH_URL::current_url_without_query_paramaters(
+										[
+											'return_action',
+											'run_datetime_offset_fix_nonce',
+											'return',
+											'datetime_tools_nonce',
+										]
+									)
+								)
+							),
+						],
+						admin_url()
+					)
+				);
+				exit;
+			}
+		}
+	}
 }