eventespresso / event-espresso-core

admin_pages/registration_form/templates/questions_main_meta_box.template.php

Indentation +127 added lines, -127 removed lines

@@ -26,21 +26,21 @@ 
 $has_answers = $question->has_answers();
 
 if ($QST_system === 'country') {
-    // already escaped
-    echo EEH_HTML::div(
-        EEH_HTML::h4(
-            '<span class="dashicons dashicons-info"></span>'
-            . esc_html__('Did you know...', 'event_espresso')
-        ) .
-        EEH_HTML::p(
-            esc_html__(
-                'If you add a State/Province Select input immediately after this Country Select input when building your registration form, then the State/Province Select input options will change to correspond with the choice made in this input. So for example, choosing "United States" in this Country Select input will populate the State/Province Select input with just the state options for the United States.',
-                'event_espresso'
-            )
-        ),
-        '',
-        'ee-info-box'
-    );
+	// already escaped
+	echo EEH_HTML::div(
+		EEH_HTML::h4(
+			'<span class="dashicons dashicons-info"></span>'
+			. esc_html__('Did you know...', 'event_espresso')
+		) .
+		EEH_HTML::p(
+			esc_html__(
+				'If you add a State/Province Select input immediately after this Country Select input when building your registration form, then the State/Province Select input options will change to correspond with the choice made in this input. So for example, choosing "United States" in this Country Select input will populate the State/Province Select input with just the state options for the United States.',
+				'event_espresso'
+			)
+		),
+		'',
+		'ee-info-box'
+	);
 }
 ?>
 
@@ -76,9 +76,9 @@ 
                     </th>
                     <td>
                         <?php
-                        $id            = ! empty($QST_system) ? '_disabled' : '';
-                        $disabled_attr = ! empty($QST_system) ? 'disabled' : '';
-                        ?>
+						$id            = ! empty($QST_system) ? '_disabled' : '';
+						$disabled_attr = ! empty($QST_system) ? 'disabled' : '';
+						?>
                         <input class='regular-text'
                                id="QST_admin_label<?php echo absint($id); ?>"
                                name="QST_admin_label<?php echo absint($id); ?>"
@@ -120,30 +120,30 @@ 
                     </th>
                     <td>
                         <?php
-                        $id            = ! empty($QST_system) ? '_disabled' : '';
-                        $disabled_attr = ! empty($QST_system) ? 'disabled' : '';
-                        $admin_only    = $question->get('QST_admin_only');
-                        $checked       = ! empty($admin_only) ? ' checked' : '';
-                        ?>
+						$id            = ! empty($QST_system) ? '_disabled' : '';
+						$disabled_attr = ! empty($QST_system) ? 'disabled' : '';
+						$admin_only    = $question->get('QST_admin_only');
+						$checked       = ! empty($admin_only) ? ' checked' : '';
+						?>
                         <input class="QST_admin_only"
                                id="QST_admin_only<?php echo absint($id); ?>"
                                name="QST_admin_only<?php echo absint($id); ?>"
                                type="checkbox"
                                value="1"
                             <?php
-                            echo esc_attr($disabled_attr);
-                            echo esc_attr($checked);
-                            ?>
+							echo esc_attr($disabled_attr);
+							echo esc_attr($checked);
+							?>
                         />
                         <br />
                         <p class="description">
                             <?php
-                            if (! empty($QST_system)) { ?>
+							if (! empty($QST_system)) { ?>
                                 <span class="description" style="color:#D54E21;">
                                     <?php esc_html_e(
-                                        'System question! This field cannot be changed.',
-                                        'event_espresso'
-                                    ); ?>
+										'System question! This field cannot be changed.',
+										'event_espresso'
+									); ?>
                                 </span>
                             <?php } ?>
                         </p>
@@ -159,44 +159,44 @@ 
                     </th>
                     <td>
                         <?php
-                        $disabled = ! empty($QST_system) && $QST_system !== EEM_Attendee::system_question_phone;
-                        if ($disabled) {
-                            $disabled_attr = 'disabled="disabled"';
-                            $id            = '_disabled';
-                        } else {
-                            $disabled_attr = '';
-                            $id            = '';
-                        }
+						$disabled = ! empty($QST_system) && $QST_system !== EEM_Attendee::system_question_phone;
+						if ($disabled) {
+							$disabled_attr = 'disabled="disabled"';
+							$id            = '_disabled';
+						} else {
+							$disabled_attr = '';
+							$id            = '';
+						}
 
-                        // Only display Confirm email for
-                        if (empty($QST_system) || $QST_system !== EEM_Attendee::system_question_email_confirm) {
-                            unset($question_types[ EEM_Question::QST_type_email_confirm ]);
-                        }
+						// Only display Confirm email for
+						if (empty($QST_system) || $QST_system !== EEM_Attendee::system_question_email_confirm) {
+							unset($question_types[ EEM_Question::QST_type_email_confirm ]);
+						}
 
-                        echo EEH_Form_Fields::select_input(
-                            'QST_type' . $id,
-                            $question_types,
-                            $question->type(),
-                            'id="QST_type' . $id . '"' . $disabled_attr
-                        ); // already escaped
-                        if ($disabled) { ?>
+						echo EEH_Form_Fields::select_input(
+							'QST_type' . $id,
+							$question_types,
+							$question->type(),
+							'id="QST_type' . $id . '"' . $disabled_attr
+						); // already escaped
+						if ($disabled) { ?>
                             <input id='QST_type'
                                    name="QST_type"
                                    type="hidden"
                                    value="<?php echo esc_attr($question->type()); ?>"
                             />
                             <?php
-                            $explanatory_text = esc_html__(
-                                'System question! This field cannot be changed.',
-                                'event_espresso'
-                            );
-                        } else {
-                            $explanatory_text = esc_html__(
-                                'Because there are currently answers for this question in the database, your options to change the question type have been limited to similar question-types.',
-                                'event_espresso'
-                            );
-                        }
-                        if ($disabled || $has_answers) { ?>
+							$explanatory_text = esc_html__(
+								'System question! This field cannot be changed.',
+								'event_espresso'
+							);
+						} else {
+							$explanatory_text = esc_html__(
+								'Because there are currently answers for this question in the database, your options to change the question type have been limited to similar question-types.',
+								'event_espresso'
+							);
+						}
+						if ($disabled || $has_answers) { ?>
                             <p>
                                 <span class="description" style="color:#D54E21;">
                                     <?php echo esc_html($explanatory_text); ?>
@@ -225,21 +225,21 @@ 
                         <p>
                             <span class="description">
                                 <?php esc_html_e(
-                                    'Maximum number of characters allowed when answering this question',
-                                    'event_espresso'
-                                ); ?>
+									'Maximum number of characters allowed when answering this question',
+									'event_espresso'
+								); ?>
                             </span>
                         </p>
                         <?php if ($QST_system) { ?>
                         <p>
                             <span class="description" style="color:#D54E21;">
                                 <?php printf(
-                                    esc_html__(
-                                        'System question! The maximum number of characters that can be used for this question is %1$s',
-                                        'event_espresso'
-                                    ),
-                                    $max_max
-                                ); ?>
+									esc_html__(
+										'System question! The maximum number of characters that can be used for this question is %1$s',
+										'event_espresso'
+									),
+									$max_max
+								); ?>
                             </span>
                         </p>
                         <?php } ?>
@@ -261,9 +261,9 @@ 
                                     </th>
                                     <th class="option-desc-header">
                                         <?php esc_html_e(
-                                            'Description (optional, only shown on registration form)',
-                                            'event_espresso'
-                                        ) ?>
+											'Description (optional, only shown on registration form)',
+											'event_espresso'
+										) ?>
                                     </th>
                                     <th>
                                     </th>
@@ -298,14 +298,14 @@ 
                                 </tr>
 
                                 <?php
-                                $count            = 0;
-                                $question_options = $question->options();
-                                if (! empty($question_options)) {
-                                    foreach ($question_options as $option_id => $option) {
-                                        $disabled_attr = $has_answers || $option->get('QSO_system')
-                                            ? 'disabled'
-                                            : '';
-                                        ?>
+								$count            = 0;
+								$question_options = $question->options();
+								if (! empty($question_options)) {
+									foreach ($question_options as $option_id => $option) {
+										$disabled_attr = $has_answers || $option->get('QSO_system')
+											? 'disabled'
+											: '';
+										?>
                                         <tr class="question-option ee-options-sortable">
                                             <td class="option-value-cell">
                                                 <input type="hidden"
@@ -342,21 +342,21 @@ 
                                     </span>
                                             </td>
                                             <?php
-                                            echo EEH_Form_Fields::hidden_input(
-                                                "question_options[{$count}][QST_ID])",
-                                                $option->question_ID()
-                                            ); // already escaped
-                                            echo EEH_Form_Fields::hidden_input(
-                                                "question_options[{$count}][QSO_ID])",
-                                                $option->ID()
-                                            ); // already escaped
-                                            $count++;
-                                            ?>
+											echo EEH_Form_Fields::hidden_input(
+												"question_options[{$count}][QST_ID])",
+												$option->question_ID()
+											); // already escaped
+											echo EEH_Form_Fields::hidden_input(
+												"question_options[{$count}][QSO_ID])",
+												$option->ID()
+											); // already escaped
+											$count++;
+											?>
                                         </tr>
                                         <?php
-                                    }
-                                } else {
-                                    ?>
+									}
+								} else {
+									?>
                                     <tr class="question-option ee-options-sortable">
                                         <td class="option-value-cell">
                                             <input type="hidden"
@@ -380,8 +380,8 @@ 
                                         </td>
                                     </tr>
                                     <?php
-                                }
-                                ?>
+								}
+								?>
                                 <tr style="display:none">
                                     <td colspan="3">
                                         <?php echo EEH_Form_Fields::hidden_input("question_options_count", $count); // already escaped ?>
@@ -400,16 +400,16 @@ 
 
                         <p class="description">
                             <?php esc_html_e(
-                                'Answer Options are the choices that you give people to select from for RADIO_BTN, CHECKBOX or DROPDOWN questions. The Value is a simple key that will be saved to the database and the description is optional. Note that values CANNOT contain any HTML, but descriptions can.',
-                                'event_espresso'
-                            ) ?>
+								'Answer Options are the choices that you give people to select from for RADIO_BTN, CHECKBOX or DROPDOWN questions. The Value is a simple key that will be saved to the database and the description is optional. Note that values CANNOT contain any HTML, but descriptions can.',
+								'event_espresso'
+							) ?>
                         </p>
                         <?php if ($has_answers) : ?>
                             <p class="description" style="color:#D54E21;">
                                 <?php esc_html_e(
-                                    'Answer values that are uneditable are this way because there are registrations in the database that have answers for this question.  If you need to correct a mistake, or edit an existing option value, then trash the existing one and create a new option with the changes.  This will ensure that the existing registrations that chose the original answer will preserve that answer.',
-                                    'event_espresso'
-                                ); ?>
+									'Answer values that are uneditable are this way because there are registrations in the database that have answers for this question.  If you need to correct a mistake, or edit an existing option value, then trash the existing one and create a new option with the changes.  This will ensure that the existing registrations that chose the original answer will preserve that answer.',
+									'event_espresso'
+								); ?>
                             </p>
 
                         <?php endif; ?>
@@ -425,40 +425,40 @@ 
                     </th>
                     <td>
                         <?php
-                        $system_required   = ['fname', 'email'];
-                        $disabled_attr     = in_array($QST_system, $system_required) ? ' disabled="disabled"' : '';
-                        $required_on       = $question->get('QST_admin_only');
-                        $show_required_msg = $required_on ? '' : ' display:none;';
-                        $disabled_attr     = $required_on || ! empty($disabled_attr) ? ' disabled="disabled"' : '';
-                        $id                =
-                            ! empty($disabled_attr) && in_array($QST_system, $system_required) ? '_disabled' : '';
-                        $requiredOptions   = [
-                            ['text' => esc_html__('Optional', 'event_espresso'), 'id' => 0],
-                            ['text' => esc_html__('Required', 'event_espresso'), 'id' => 1],
-                        ];
-                        echo EEH_Form_Fields::select_input(
-                            'QST_required' . $id,
-                            $requiredOptions,
-                            $question->required(),
-                            'id="QST_required' . $id . '"' . $disabled_attr
-                        ); // already escaped
-                        ?>
+						$system_required   = ['fname', 'email'];
+						$disabled_attr     = in_array($QST_system, $system_required) ? ' disabled="disabled"' : '';
+						$required_on       = $question->get('QST_admin_only');
+						$show_required_msg = $required_on ? '' : ' display:none;';
+						$disabled_attr     = $required_on || ! empty($disabled_attr) ? ' disabled="disabled"' : '';
+						$id                =
+							! empty($disabled_attr) && in_array($QST_system, $system_required) ? '_disabled' : '';
+						$requiredOptions   = [
+							['text' => esc_html__('Optional', 'event_espresso'), 'id' => 0],
+							['text' => esc_html__('Required', 'event_espresso'), 'id' => 1],
+						];
+						echo EEH_Form_Fields::select_input(
+							'QST_required' . $id,
+							$requiredOptions,
+							$question->required(),
+							'id="QST_required' . $id . '"' . $disabled_attr
+						); // already escaped
+						?>
                         <p>
                             <span id="required_toggled_on" class="description"
                                   style="color:#D54E21;<?php echo esc_attr($show_required_msg); ?>"
                             >
                                 <?php esc_html_e(
-                                    'Required is set to optional, and this field is disabled, because the question is Admin-Only.',
-                                    'event_espresso'
-                                ) ?>
+									'Required is set to optional, and this field is disabled, because the question is Admin-Only.',
+									'event_espresso'
+								) ?>
                             </span
                         </p>
                         <p>
                             <span id="required_toggled_off" class="description" style="color:#D54E21; display: none;">
                                 <?php esc_html_e(
-                                    'Required option field is no longer disabled because the question is not Admin-Only',
-                                    'event_espresso'
-                                ) ?>
+									'Required option field is no longer disabled because the question is not Admin-Only',
+									'event_espresso'
+								) ?>
                             </span>
                         </p>
                         <?php if (! empty($disabled_attr) && in_array($QST_system, $system_required)) { ?>
@@ -491,8 +491,8 @@ 
                     </td>
                 </tr>
                 <?php
-                do_action('AHEE__questions_main_meta_box__template__after_table_form_table', $question);
-                ?>
+				do_action('AHEE__questions_main_meta_box__template__after_table_form_table', $question);
+				?>
             </tbody>
         </table>
 

Spacing +13 added lines, -13 removed lines

@@ -31,7 +31,7 @@ 
         EEH_HTML::h4(
             '<span class="dashicons dashicons-info"></span>'
             . esc_html__('Did you know...', 'event_espresso')
-        ) .
+        ).
         EEH_HTML::p(
             esc_html__(
                 'If you add a State/Province Select input immediately after this Country Select input when building your registration form, then the State/Province Select input options will change to correspond with the choice made in this input. So for example, choosing "United States" in this Country Select input will populate the State/Province Select input with just the state options for the United States.',
@@ -92,7 +92,7 @@ 
                                type="hidden"
                                value="<?php echo esc_attr($question->get('QST_order')); ?>"
                         />
-                        <?php if (! empty($QST_system)) { ?>
+                        <?php if ( ! empty($QST_system)) { ?>
                             <input id='QST_admin_label'
                                    name="QST_admin_label"
                                    type="hidden"
@@ -101,7 +101,7 @@ 
                         <?php } ?>
                         <br />
                         <p class="description">
-                            <?php if (! empty($QST_system)) { ?>
+                            <?php if ( ! empty($QST_system)) { ?>
                                 <span class="description" style="color:#D54E21;">
                                 <?php esc_html_e('System question! This field cannot be changed.', 'event_espresso') ?>
                         </span>
@@ -138,7 +138,7 @@ 
                         <br />
                         <p class="description">
                             <?php
-                            if (! empty($QST_system)) { ?>
+                            if ( ! empty($QST_system)) { ?>
                                 <span class="description" style="color:#D54E21;">
                                     <?php esc_html_e(
                                         'System question! This field cannot be changed.',
@@ -170,14 +170,14 @@ 
 
                         // Only display Confirm email for
                         if (empty($QST_system) || $QST_system !== EEM_Attendee::system_question_email_confirm) {
-                            unset($question_types[ EEM_Question::QST_type_email_confirm ]);
+                            unset($question_types[EEM_Question::QST_type_email_confirm]);
                         }
 
                         echo EEH_Form_Fields::select_input(
-                            'QST_type' . $id,
+                            'QST_type'.$id,
                             $question_types,
                             $question->type(),
-                            'id="QST_type' . $id . '"' . $disabled_attr
+                            'id="QST_type'.$id.'"'.$disabled_attr
                         ); // already escaped
                         if ($disabled) { ?>
                             <input id='QST_type'
@@ -216,7 +216,7 @@ 
                     </th>
                     <td>
                         <input id="QST_max"
-                            <?php echo $max_max === EE_INF ? '' : 'max="' . esc_attr($max_max) . '"'; ?>
+                            <?php echo $max_max === EE_INF ? '' : 'max="'.esc_attr($max_max).'"'; ?>
                                min="1"
                                name="QST_max"
                                type="number"
@@ -300,7 +300,7 @@ 
                                 <?php
                                 $count            = 0;
                                 $question_options = $question->options();
-                                if (! empty($question_options)) {
+                                if ( ! empty($question_options)) {
                                     foreach ($question_options as $option_id => $option) {
                                         $disabled_attr = $has_answers || $option->get('QSO_system')
                                             ? 'disabled'
@@ -334,7 +334,7 @@ 
                                                 />
                                             </td>
                                             <td>
-                                                <?php if (! $option->system()) { ?>
+                                                <?php if ( ! $option->system()) { ?>
                                                     <span class="dashicons clickable dashicons-post-trash ee-icon-size-18 remove-option remove-item">
                                         </span>
                                                 <?php } ?>
@@ -437,10 +437,10 @@ 
                             ['text' => esc_html__('Required', 'event_espresso'), 'id' => 1],
                         ];
                         echo EEH_Form_Fields::select_input(
-                            'QST_required' . $id,
+                            'QST_required'.$id,
                             $requiredOptions,
                             $question->required(),
-                            'id="QST_required' . $id . '"' . $disabled_attr
+                            'id="QST_required'.$id.'"'.$disabled_attr
                         ); // already escaped
                         ?>
                         <p>
@@ -461,7 +461,7 @@ 
                                 ) ?>
                             </span>
                         </p>
-                        <?php if (! empty($disabled_attr) && in_array($QST_system, $system_required)) { ?>
+                        <?php if ( ! empty($disabled_attr) && in_array($QST_system, $system_required)) { ?>
                             <input type="hidden" id="QST_required" name="QST_required" value="1" />
                             <p>
                             <span class="description" style="color:#D54E21;">

admin_pages/venues/templates/google_map.template.php

Indentation +66 added lines, -66 removed lines

@@ -16,21 +16,21 @@ 
                 </th>
                 <td>
                     <?php echo EEH_Form_Fields::select_input(
-                        'use_google_maps',
-                        $values,
-                        $map_settings->use_google_maps,
-                        'id="ee-display-map-no-shortcodes"'
-                    ); ?>
+						'use_google_maps',
+						$values,
+						$map_settings->use_google_maps,
+						'id="ee-display-map-no-shortcodes"'
+					); ?>
                     <p class="description">
                         <?php esc_html_e(
-                            'Turn Google maps on or off site wide for Event Espresso.',
-                            'event_espresso'
-                        ); ?>
+							'Turn Google maps on or off site wide for Event Espresso.',
+							'event_espresso'
+						); ?>
                     </p>
                 </td>
             </tr>
             <?php
-            if (apply_filters('FHEE__google_map__show_api_key_input', true)) { ?>
+			if (apply_filters('FHEE__google_map__show_api_key_input', true)) { ?>
                 <tr>
                     <th>
                         <label for="ee-google-map-api-key">
@@ -46,14 +46,14 @@ 
                         />
                         <p class="description">
                             <?php printf(
-                                esc_html__(
-                                    'An API key is now required to use the Google Maps API: %1$sclick here to get an API key%2$s',
-                                    'event_espresso'
-                                ),
-                                '<a href="https://console.developers.google.com/flows/enableapi?apiid=maps_backend,geocoding_backend,directions_backend,distance_matrix_backend,elevation_backend,static_maps_backend&keyType=CLIENT_SIDE&reusekey=true" target="_blank" rel="noopener noreferrer">',
-                                '</a>'
-                            );
-                            ?>
+								esc_html__(
+									'An API key is now required to use the Google Maps API: %1$sclick here to get an API key%2$s',
+									'event_espresso'
+								),
+								'<a href="https://console.developers.google.com/flows/enableapi?apiid=maps_backend,geocoding_backend,directions_backend,distance_matrix_backend,elevation_backend,static_maps_backend&keyType=CLIENT_SIDE&reusekey=true" target="_blank" rel="noopener noreferrer">',
+								'</a>'
+							);
+							?>
                         </p>
                     </td>
                 </tr>
@@ -125,11 +125,11 @@ 
                 </th>
                 <td>
                     <?php echo EEH_Form_Fields::select_input(
-                        'event_details_display_nav',
-                        $values,
-                        $map_settings->event_details_display_nav,
-                        'id="event_details_display_nav" '
-                    ); ?>
+						'event_details_display_nav',
+						$values,
+						$map_settings->event_details_display_nav,
+						'id="event_details_display_nav" '
+					); ?>
                 </td>
             </tr>
 
@@ -141,11 +141,11 @@ 
                 </th>
                 <td>
                     <?php echo EEH_Form_Fields::select_input(
-                        'event_details_nav_size',
-                        $values,
-                        $map_settings->event_details_nav_size,
-                        'id="event_details_nav_size"'
-                    ); ?>
+						'event_details_nav_size',
+						$values,
+						$map_settings->event_details_nav_size,
+						'id="event_details_nav_size"'
+					); ?>
                 </td>
             </tr>
 
@@ -156,8 +156,8 @@ 
                 <td>
                     <label for="event_details_control_type-default" class="ee-admin-radio-lbl">
                         <?php $checked = $map_settings->event_details_control_type == 'default'
-                            ? 'checked'
-                            : ''; ?>
+							? 'checked'
+							: ''; ?>
                         <input id="event_details_control_type-default"
                                type="radio"
                                name="event_details_control_type"
@@ -169,8 +169,8 @@ 
 
                     <label for="event_details_control_type-horizontal" class="ee-admin-radio-lbl">
                         <?php $checked = $map_settings->event_details_control_type == 'horizontal'
-                            ? 'checked'
-                            : ''; ?>
+							? 'checked'
+							: ''; ?>
                         <input id="event_details_control_type-horizontal"
                                type="radio"
                                name="event_details_control_type"
@@ -182,8 +182,8 @@ 
 
                     <label for="event_details_control_type-dropdown" class="ee-admin-radio-lbl">
                         <?php $checked = $map_settings->event_details_control_type == 'dropdown'
-                            ? 'checked'
-                            : ''; ?>
+							? 'checked'
+							: ''; ?>
                         <input id="event_details_control_type-dropdown"
                                type="radio"
                                name="event_details_control_type"
@@ -201,8 +201,8 @@ 
                 <td>
                     <label for="event_details_map_align-none" class="ee-admin-radio-lbl">
                         <?php $checked = $map_settings->event_details_map_align == 'none'
-                            ? 'checked'
-                            : ''; ?>
+							? 'checked'
+							: ''; ?>
                         <input id="event_details_map_align-none"
                                type="radio"
                                name="event_details_map_align"
@@ -214,8 +214,8 @@ 
 
                     <label for="event_details_map_align-left" class="ee-admin-radio-lbl">
                         <?php $checked = $map_settings->event_details_map_align == 'left'
-                            ? 'checked'
-                            : ''; ?>
+							? 'checked'
+							: ''; ?>
                         <input id="event_details_map_align-left"
                                type="radio"
                                name="event_details_map_align"
@@ -227,8 +227,8 @@ 
 
                     <label for="event_details_map_align-center" class="ee-admin-radio-lbl">
                         <?php $checked = $map_settings->event_details_map_align == 'center'
-                            ? 'checked'
-                            : ''; ?>
+							? 'checked'
+							: ''; ?>
                         <input id="event_details_map_align-center"
                                type="radio"
                                name="event_details_map_align"
@@ -240,8 +240,8 @@ 
 
                     <label for="event_details_map_align-right" class="ee-admin-radio-lbl">
                         <?php $checked = $map_settings->event_details_map_align == 'right'
-                            ? 'checked'
-                            : ''; ?>
+							? 'checked'
+							: ''; ?>
                         <input id="event_details_map_align-right"
                                type="radio"
                                name="event_details_map_align"
@@ -317,11 +317,11 @@ 
                 </th>
                 <td>
                     <?php echo EEH_Form_Fields::select_input(
-                        'event_list_display_nav',
-                        $values,
-                        $map_settings->event_list_display_nav,
-                        'id="event_list_display_nav"'
-                    ); ?>
+						'event_list_display_nav',
+						$values,
+						$map_settings->event_list_display_nav,
+						'id="event_list_display_nav"'
+					); ?>
                 </td>
             </tr>
 
@@ -333,11 +333,11 @@ 
                 </th>
                 <td>
                     <?php echo EEH_Form_Fields::select_input(
-                        'event_list_nav_size',
-                        $values,
-                        $map_settings->event_list_nav_size,
-                        'id="event_list_nav_size"'
-                    ); ?>
+						'event_list_nav_size',
+						$values,
+						$map_settings->event_list_nav_size,
+						'id="event_list_nav_size"'
+					); ?>
                 </td>
             </tr>
 
@@ -348,8 +348,8 @@ 
                 <td>
                     <label for="event_list_control_type-default" class="ee-admin-radio-lbl">
                         <?php $checked = $map_settings->event_list_control_type == 'default'
-                            ? 'checked'
-                            : ''; ?>
+							? 'checked'
+							: ''; ?>
                         <input id="event_list_control_type-default"
                                type="radio"
                                name="event_list_control_type"
@@ -361,8 +361,8 @@ 
 
                     <label for="event_list_control_type-horizontal" class="ee-admin-radio-lbl">
                         <?php $checked = $map_settings->event_list_control_type == 'horizontal'
-                            ? 'checked'
-                            : ''; ?>
+							? 'checked'
+							: ''; ?>
                         <input id="event_list_control_type-horizontal"
                                type="radio"
                                name="event_list_control_type"
@@ -374,9 +374,9 @@ 
 
                     <label for="event_list_control_type-dropdown" class="ee-admin-radio-lbl">
                         <?php $checked =
-                            $map_settings->event_list_control_type == 'dropdown'
-                                ? 'checked'
-                                : ''; ?>
+							$map_settings->event_list_control_type == 'dropdown'
+								? 'checked'
+								: ''; ?>
                         <input id="event_list_control_type-dropdown"
                                type="radio"
                                name="event_list_control_type"
@@ -396,8 +396,8 @@ 
                 <td>
                     <label for="event_list_map_align-none" class="ee-admin-radio-lbl">
                         <?php $checked = $map_settings->event_list_map_align == 'none'
-                            ? 'checked'
-                            : ''; ?>
+							? 'checked'
+							: ''; ?>
                         <input id="event_list_map_align-none"
                                type="radio"
                                name="event_list_map_align"
@@ -409,8 +409,8 @@ 
 
                     <label for="event_list_map_align-left" class="ee-admin-radio-lbl">
                         <?php $checked = $map_settings->event_list_map_align == 'left'
-                            ? 'checked'
-                            : ''; ?>
+							? 'checked'
+							: ''; ?>
                         <input id="event_list_map_align-left"
                                type="radio"
                                name="event_list_map_align"
@@ -422,8 +422,8 @@ 
 
                     <label for="event_list_map_align-center" class="ee-admin-radio-lbl">
                         <?php $checked = $map_settings->event_list_map_align == 'center'
-                            ? 'checked'
-                            : ''; ?>
+							? 'checked'
+							: ''; ?>
                         <input id="event_list_map_align-center"
                                type="radio"
                                name="event_list_map_align"
@@ -435,8 +435,8 @@ 
 
                     <label for="event_list_map_align-right" class="ee-admin-radio-lbl">
                         <?php $checked = $map_settings->event_list_map_align == 'right'
-                            ? 'checked'
-                            : ''; ?>
+							? 'checked'
+							: ''; ?>
                         <input id="event_list_map_align-right"
                                type="radio"
                                name="event_list_map_align"

admin_pages/general_settings/templates/state_details_settings.template.php

Indentation +16 added lines, -16 removed lines

@@ -12,26 +12,26 @@ 
         <th colspan="2">
             <span class="small-text">
                 <?php printf(
-                    esc_html__('State Appears in%1$sDropdown Select Lists ', 'event_espresso'),
-                    '<br />'
-                ); ?>
+					esc_html__('State Appears in%1$sDropdown Select Lists ', 'event_espresso'),
+					'<br />'
+				); ?>
             </span>
         </th>
     </tr>
     </thead>
     <tbody>
     <?php
-    if ($states) {
-        foreach ($states as $STA_ID => $state) {
-            ?>
+	if ($states) {
+		foreach ($states as $STA_ID => $state) {
+			?>
         <tr id="state-<?php echo absint($STA_ID); ?>-tr" class="country-state-columns">
             <?php
-            foreach ($state['inputs'] as $ID => $input) {
-                if ($ID != 'STA_ID' && $ID != 'CNT_ISO') {
-                    echo EEH_Form_Fields::generate_form_input($input); // already escaped
-                }
-            }
-            ?>
+			foreach ($state['inputs'] as $ID => $input) {
+				if ($ID != 'STA_ID' && $ID != 'CNT_ISO') {
+					echo EEH_Form_Fields::generate_form_input($input); // already escaped
+				}
+			}
+			?>
             <td class="delete-state-td">
                 <a class="dashicons dashicons-post-trash ee-icon-size-20 delete-state-lnk"
                    id="delete-state-<?php echo absint($STA_ID); ?>-lnk"
@@ -43,8 +43,8 @@ 
             </td>
         </tr>
             <?php
-        }
-        ?>
+		}
+		?>
     </tbody>
 </table>
 <br/>
@@ -56,8 +56,8 @@ 
 />
 <br/>
         <?php
-    }
-    ?>
+	}
+	?>
 <table class="form-table add-new-state-tbl">
     <tbody>
     <tr>

admin_pages/messages/Messages_Admin_Page.core.php

Spacing +221 added lines, -221 removed lines

@@ -114,7 +114,7 @@ 
      */
     public function getMsgModel()
     {
-        if (! $this->MSG_MODEL instanceof EEM_Message) {
+        if ( ! $this->MSG_MODEL instanceof EEM_Message) {
             $this->MSG_MODEL = EEM_Message::instance();
         }
         return $this->MSG_MODEL;
@@ -127,7 +127,7 @@ 
      */
     public function getMtpModel()
     {
-        if (! $this->MTP_MODEL instanceof EEM_Message_Template) {
+        if ( ! $this->MTP_MODEL instanceof EEM_Message_Template) {
             $this->MTP_MODEL = EEM_Message_Template::instance();
         }
         return $this->MTP_MODEL;
@@ -140,7 +140,7 @@ 
      */
     public function getMtgModel()
     {
-        if (! $this->MTG_MODEL instanceof EEM_Message_Template_Group) {
+        if ( ! $this->MTG_MODEL instanceof EEM_Message_Template_Group) {
             $this->MTG_MODEL = EEM_Message_Template_Group::instance();
         }
         return $this->MTG_MODEL;
@@ -210,8 +210,8 @@ 
         $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());
+                $m_values[$i]['id']   = $active_messenger->messenger();
+                $m_values[$i]['text'] = ucwords($active_messenger->messenger_label());
                 $i++;
             }
         }
@@ -247,8 +247,8 @@ 
         $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());
+                $mt_values[$i]['id']   = $active_message->message_type();
+                $mt_values[$i]['text'] = ucwords($active_message->message_type_label());
                 $i++;
             }
         }
@@ -287,7 +287,7 @@ 
                 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'];
+                        $contexts[$context] = $context_details['label'];
                     }
                 }
             }
@@ -320,7 +320,7 @@ 
             ['none_selected' => esc_html__('Show All Messengers', 'event_espresso')],
             $messenger_options
         );
-        $input             = new EE_Select_Input(
+        $input = new EE_Select_Input(
             $messenger_options,
             [
                 'html_name'  => 'ee_messenger_filter_by',
@@ -357,7 +357,7 @@ 
             ['none_selected' => esc_html__('Show All Message Types', 'event_espresso')],
             $message_type_options
         );
-        $input                = new EE_Select_Input(
+        $input = new EE_Select_Input(
             $message_type_options,
             [
                 'html_name'  => 'ee_message_type_filter_by',
@@ -394,7 +394,7 @@ 
             ['none_selected' => esc_html__('Show all Contexts', 'event_espresso')],
             $context_options
         );
-        $input           = new EE_Select_Input(
+        $input = new EE_Select_Input(
             $context_options,
             [
                 'html_name'  => 'ee_context_filter_by',
@@ -768,53 +768,53 @@ 
 
     public function messages_help_tab()
     {
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_help_tab.template.php');
+        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');
+        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');
+        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');
+        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');
+        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="'
+        $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="'
+        $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="'
+        $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="'
+        $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="'
+        $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',
+            EE_MSG_TEMPLATE_PATH.'ee_msg_messages_templates_editor_help_tab.template.php',
             $args
         );
     }
@@ -829,7 +829,7 @@ 
         $this->_set_shortcodes();
         $args['shortcodes'] = $this->_shortcodes;
         EEH_Template::display_template(
-            EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_shortcodes_help_tab.template.php',
+            EE_MSG_TEMPLATE_PATH.'ee_msg_messages_shortcodes_help_tab.template.php',
             $args
         );
     }
@@ -837,16 +837,16 @@ 
 
     public function preview_message_help_tab()
     {
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_preview_help_tab.template.php');
+        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['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="checked">'
@@ -857,25 +857,25 @@ 
                         . ' 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);
+        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_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',
+            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_MSG_ASSETS_URL.'ee_message_admin_list_table.js',
             ['ee-dialog'],
             EVENT_ESPRESSO_VERSION
         );
@@ -918,7 +918,7 @@ 
 
         $this->_set_shortcodes();
 
-        EE_Registry::$i18n_js_strings['confirm_default_reset']        = sprintf(
+        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'
@@ -930,14 +930,14 @@ 
             '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__(
+        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',
+            EE_MSG_ASSETS_URL.'ee_message_editor.js',
             ['jquery'],
             EVENT_ESPRESSO_VERSION
         );
@@ -980,7 +980,7 @@ 
     {
         wp_register_style(
             'ee-message-settings',
-            EE_MSG_ASSETS_URL . 'ee_message_settings.css',
+            EE_MSG_ASSETS_URL.'ee_message_settings.css',
             [],
             EVENT_ESPRESSO_VERSION
         );
@@ -1066,7 +1066,7 @@ 
             }
             $status_bulk_actions = $common_bulk_actions;
             // unset bulk actions not applying to status
-            if (! empty($status_bulk_actions)) {
+            if ( ! empty($status_bulk_actions)) {
                 switch ($status) {
                     case EEM_Message::status_idle:
                     case EEM_Message::status_resend:
@@ -1095,7 +1095,7 @@ 
                 continue;
             }
 
-            $this->_views[ strtolower($status) ] = [
+            $this->_views[strtolower($status)] = [
                 'slug'        => strtolower($status),
                 'label'       => EEH_Template::pretty_status($status, false, 'sentence'),
                 'count'       => 0,
@@ -1144,7 +1144,7 @@ 
             if ($action_item === 'see_notifications_for') {
                 continue;
             }
-            $action_items[ $action_item ] = [
+            $action_items[$action_item] = [
                 'class' => $action_details['css_class'],
                 'desc'  => $action_details['label'],
             ];
@@ -1153,37 +1153,37 @@ 
         /** @var array $status_items status legend setup */
         $status_items = [
             'sent_status'                => [
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_sent,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Message::status_sent,
                 'desc'  => EEH_Template::pretty_status(EEM_Message::status_sent, false, 'sentence'),
             ],
             'idle_status'                => [
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_idle,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Message::status_idle,
                 'desc'  => EEH_Template::pretty_status(EEM_Message::status_idle, false, 'sentence'),
             ],
             'failed_status'              => [
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_failed,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Message::status_failed,
                 'desc'  => EEH_Template::pretty_status(EEM_Message::status_failed, false, 'sentence'),
             ],
             'messenger_executing_status' => [
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_messenger_executing,
+                'class' => 'ee-status-legend ee-status-legend-'.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-legend-' . EEM_Message::status_resend,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Message::status_resend,
                 'desc'  => EEH_Template::pretty_status(EEM_Message::status_resend, false, 'sentence'),
             ],
             'incomplete_status'          => [
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_incomplete,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Message::status_incomplete,
                 'desc'  => EEH_Template::pretty_status(EEM_Message::status_incomplete, false, 'sentence'),
             ],
             'retry_status'               => [
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_retry,
+                'class' => 'ee-status-legend ee-status-legend-'.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-legend-' . EEM_Message::status_debug_only,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Message::status_debug_only,
                 'desc'  => EEH_Template::pretty_status(EEM_Message::status_debug_only, false, 'sentence'),
             ];
         }
@@ -1198,11 +1198,11 @@ 
     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__(
+        $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.',
@@ -1278,7 +1278,7 @@ 
         $installed               = [];
 
         foreach ($installed_message_types as $message_type) {
-            $installed[ $message_type->name ] = $message_type;
+            $installed[$message_type->name] = $message_type;
         }
 
         return $installed;
@@ -1404,7 +1404,7 @@ 
         // we need to assemble the title from Various details
         $context_label = sprintf(
             esc_html__('(%s %s)', 'event_espresso'),
-            $c_config[ $context ]['label'],
+            $c_config[$context]['label'],
             ucwords($c_label['label'])
         );
 
@@ -1426,7 +1426,7 @@ 
             $message_template_group->message_type()
         );
 
-        if (! $template_field_structure) {
+        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)',
@@ -1440,21 +1440,21 @@ 
 
         // 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 ]);
+        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 ( ! 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 ];
+                        $message_template = $message_templates[$context][$reference_field];
                         $content          = $message_template instanceof EE_Message_Template
                             ? $message_template->get('MTP_content')
                             : '';
@@ -1463,7 +1463,7 @@ 
                             $continue = false;
                             if (isset($extra_array['shortcodes_required'])) {
                                 foreach ((array) $extra_array['shortcodes_required'] as $shortcode) {
-                                    if (! array_key_exists($shortcode, $this->_shortcodes)) {
+                                    if ( ! array_key_exists($shortcode, $this->_shortcodes)) {
                                         $continue = true;
                                     }
                                 }
@@ -1472,53 +1472,53 @@ 
                                 }
                             }
 
-                            $field_id = $reference_field . '-' . $extra_field . '-content';
+                            $field_id = $reference_field.'-'.$extra_field.'-content';
 
-                            $template_form_fields[ $field_id ]         = $extra_array;
-                            $template_form_fields[ $field_id ]['name'] = 'MTP_template_fields['
+                            $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_field.']';
+                            $css_class = isset($extra_array['css_class'])
                                 ? $extra_array['css_class']
                                 : '';
 
-                            $template_form_fields[ $field_id ]['css_class'] = ! empty($v_fields)
+                            $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'])
+                                                                                  is_array($validators[$extra_field])
+                                                                                  && isset($validators[$extra_field]['msg'])
                                                                               )
-                                ? 'validate-error ' . $css_class
+                                ? 'validate-error '.$css_class
                                 : $css_class;
 
-                            $template_form_fields[ $field_id ]['value'] = ! empty($message_templates)
-                                                                          && isset($content[ $extra_field ])
-                                ? $content[ $extra_field ]
+                            $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]['value'] = isset($validators[$extra_field])
+                                ? $validators[$extra_field]['value']
+                                : $template_form_fields[$field_id]['value'];
 
 
-                            $template_form_fields[ $field_id ]['db-col'] = 'MTP_content';
+                            $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(
+                            $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_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]',
+                        $template_form_fields[$template_field_MTP_id] = [
+                            'name'       => 'MTP_template_fields['.$reference_field.'][MTP_ID]',
                             'label'      => null,
                             'input'      => 'hidden',
                             'type'       => 'int',
@@ -1530,8 +1530,8 @@ 
                             'db-col'     => 'MTP_ID',
                         ];
 
-                        $template_form_fields[ $template_field_template_name_id ] = [
-                            'name'       => 'MTP_template_fields[' . $reference_field . '][name]',
+                        $template_form_fields[$template_field_template_name_id] = [
+                            'name'       => 'MTP_template_fields['.$reference_field.'][name]',
                             'label'      => null,
                             'input'      => 'hidden',
                             'type'       => 'string',
@@ -1545,38 +1545,38 @@ 
                     }
                     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]';
+                    $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 ]
+                        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 ])
+                    $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]['value'] = isset($validators[$template_field])
+                        ? $validators[$template_field]['value']
+                        : $template_form_fields[$field_id]['value'];
 
 
-                    $template_form_fields[ $field_id ]['db-col']    = 'MTP_content';
+                    $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)
+                    $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
+                                                                      && 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_form_fields[$field_id]['append_content'] = $this->_get_shortcode_selector(
                         $template_field,
                         $field_id
                     );
@@ -1584,12 +1584,12 @@ 
 
                 // 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';
+                $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]',
+                $template_form_fields[$template_field_MTP_id] = [
+                    'name'       => 'MTP_template_fields['.$template_field.'][MTP_ID]',
                     'label'      => null,
                     'input'      => 'hidden',
                     'type'       => 'int',
@@ -1601,8 +1601,8 @@ 
                     'db-col'     => 'MTP_ID',
                 ];
 
-                $template_form_fields[ $template_field_field_template_name_id ] = [
-                    'name'       => 'MTP_template_fields[' . $template_field . '][name]',
+                $template_form_fields[$template_field_field_template_name_id] = [
+                    'name'       => 'MTP_template_fields['.$template_field.'][name]',
                     'label'      => null,
                     'input'      => 'hidden',
                     'type'       => 'string',
@@ -1719,7 +1719,7 @@ 
                 'format'     => '%d',
                 'db-col'     => 'MTP_deleted',
             ];
-            $sidebar_form_fields['ee-msg-author']  = [
+            $sidebar_form_fields['ee-msg-author'] = [
                 'name'       => 'MTP_user_id',
                 'label'      => esc_html__('Author', 'event_espresso'),
                 'input'      => 'hidden',
@@ -1738,17 +1738,17 @@ 
                 'value' => $action,
             ];
 
-            $sidebar_form_fields['ee-msg-id']        = [
+            $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',
+                'name'  => $action.'_nonce',
                 'input' => 'hidden',
                 'type'  => 'string',
-                'value' => wp_create_nonce($action . '_nonce'),
+                'value' => wp_create_nonce($action.'_nonce'),
             ];
 
             $template_switch = $this->request->getRequestParam('template_switch');
@@ -1779,7 +1779,7 @@ 
         );
 
         // add preview button
-        $preview_url    = parent::add_query_args_and_nonce(
+        $preview_url = parent::add_query_args_and_nonce(
             [
                 'message_type' => $message_template_group->message_type(),
                 'messenger'    => $message_template_group->messenger(),
@@ -1790,7 +1790,7 @@ 
             ],
             $this->_admin_base_url
         );
-        $preview_button = '<a href="' . $preview_url . '" class="button-secondary messages-preview-button">'
+        $preview_button = '<a href="'.$preview_url.'" class="button-secondary messages-preview-button">'
                           . esc_html__('Preview', 'event_espresso')
                           . '</a>';
 
@@ -1826,11 +1826,11 @@ 
             $context_label
         );
         $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_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';
+            : 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;
@@ -1886,7 +1886,7 @@ 
     ) {
         $template_args = [
             'context'                   => $context,
-            'nonce'                     => wp_create_nonce('activate_' . $context . '_toggle_nonce'),
+            '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'
@@ -1895,7 +1895,7 @@ 
             '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',
+            EE_MSG_TEMPLATE_PATH.'ee_msg_editor_active_context_element.template.php',
             $template_args,
             true
         );
@@ -1952,7 +1952,7 @@ 
         }
         $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) {
+        if ( ! $message_template_group instanceof EE_Message_Template_Group) {
             EE_Error::add_error(
                 sprintf(
                     esc_html__(
@@ -2083,7 +2083,7 @@ 
         $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)) {
+        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.',
@@ -2120,7 +2120,7 @@ 
         }
 
         // any error messages?
-        if (! $success) {
+        if ( ! $success) {
             EE_Error::add_error(
                 esc_html__(
                     'Something went wrong with deleting existing templates. Unable to reset to default',
@@ -2169,7 +2169,7 @@ 
     {
         // 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)) {
+        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__,
@@ -2195,7 +2195,7 @@ 
         $EVT_ID = $this->request->getRequestParam('evt_id', 0, 'int');
 
         // let's add a button to go back to the edit view
-        $query_args             = [
+        $query_args = [
             'id'      => $GRP_ID,
             'evt_id'  => $EVT_ID,
             'context' => $context,
@@ -2216,7 +2216,7 @@ 
         $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'])
+            ucwords($message_types[$this->_active_message_type_name]->label['singular'])
         );
         if (empty($preview)) {
             $this->noEventsErrorMessage();
@@ -2224,7 +2224,7 @@ 
         // 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['admin_page_content'] = $preview_button.'<br />'.$preview;
         $this->_template_args['data']['force_json'] = true;
 
         return '';
@@ -2245,7 +2245,7 @@ 
             ],
             admin_url('admin.php')
         );
-        $message    = $test_send
+        $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'
@@ -2338,10 +2338,10 @@ 
             // only include template packs that support this messenger and message type!
             $supports = $tp->get_supports();
             if (
-                ! isset($supports[ $this->_message_template_group->messenger() ])
+                ! isset($supports[$this->_message_template_group->messenger()])
                 || ! in_array(
                     $this->_message_template_group->message_type(),
-                    $supports[ $this->_message_template_group->messenger() ],
+                    $supports[$this->_message_template_group->messenger()],
                     true
                 )
             ) {
@@ -2365,7 +2365,7 @@ 
         }
 
         // setup variation select values for the currently selected template.
-        $variations               = $this->_message_template_group->get_template_pack()->get_variations(
+        $variations = $this->_message_template_group->get_template_pack()->get_variations(
             $this->_message_template_group->messenger(),
             $this->_message_template_group->message_type()
         );
@@ -2379,12 +2379,12 @@ 
 
         $template_pack_labels = $this->_message_template_group->messenger_obj()->get_supports_labels();
 
-        $template_args['template_packs_selector']        = EEH_Form_Fields::select_input(
+        $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(
+        $template_args['variations_selector'] = EEH_Form_Fields::select_input(
             'MTP_template_variation',
             $variations_select_values,
             $this->_message_template_group->get_template_pack_variation()
@@ -2394,7 +2394,7 @@ 
         $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';
+        $template = EE_MSG_TEMPLATE_PATH.'template_pack_and_variations_metabox.template.php';
 
         EEH_Template::display_template($template, $template_args);
     }
@@ -2420,33 +2420,33 @@ 
         // first we need to see if there are any fields
         $fields = $this->_message_template_group->messenger_obj()->get_test_settings_fields();
 
-        if (! empty($fields)) {
+        if ( ! empty($fields)) {
             // yup there be fields
             foreach ($fields as $field => $config) {
-                $field_id = $this->_message_template_group->messenger() . '_' . $field;
+                $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 ])
+                $fix = $config['input'] === 'hidden'
+                                      && isset($existing[$field])
+                                      && empty($existing[$field])
                     ? $default
                     : '';
-                $existing[ $field ] = isset($existing[ $field ]) && empty($fix)
-                    ? $existing[ $field ]
+                $existing[$field] = isset($existing[$field]) && empty($fix)
+                    ? $existing[$field]
                     : $fix;
 
-                $template_form_fields[ $field_id ] = [
-                    'name'       => 'test_settings_fld[' . $field . ']',
+                $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,
+                    'value'      => isset($existing[$field]) ? $existing[$field] : $default,
                     'css_class'  => $config['css_class'],
                     'options'    => isset($config['options']) ? $config['options'] : [],
                     'default'    => $default,
@@ -2460,7 +2460,7 @@ 
             : '';
 
         // print out $test_settings_fields
-        if (! empty($test_settings_html)) {
+        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');
@@ -2506,7 +2506,7 @@ 
         ];
 
         return EEH_Template::display_template(
-            EE_MSG_TEMPLATE_PATH . 'shortcode_selector_skeleton.template.php',
+            EE_MSG_TEMPLATE_PATH.'shortcode_selector_skeleton.template.php',
             $template_args,
             true
         );
@@ -2532,7 +2532,7 @@ 
         // $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>';
+            echo '<p>'.esc_html__('There are no valid shortcodes available', 'event_espresso').'</p>';
             return;
         }
         ?>
@@ -2568,7 +2568,7 @@ 
     {
 
         // no need to run this if the property is already set
-        if (! empty($this->_shortcodes)) {
+        if ( ! empty($this->_shortcodes)) {
             return;
         }
 
@@ -2623,7 +2623,7 @@ 
     protected function _set_message_template_group()
     {
         // get out if this is already set.
-        if (! empty($this->_message_template_group)) {
+        if ( ! empty($this->_message_template_group)) {
             return;
         }
 
@@ -2669,8 +2669,8 @@ 
                     <?php
                 }
                 // setup nonce_url
-                wp_nonce_field($args['action'] . '_nonce', $args['action'] . '_nonce', false);
-                $id = 'ee-' . sanitize_key($context_label['label']) . '-select';
+                wp_nonce_field($args['action'].'_nonce', $args['action'].'_nonce', false);
+                $id = 'ee-'.sanitize_key($context_label['label']).'-select';
                 ?>
                 <label for='<?php echo absint($id); ?>' class='screen-reader-text'>
                     <?php esc_html_e('message context options', 'event_espresso'); ?>
@@ -2683,7 +2683,7 @@ 
                             $checked = ($context === $args['context']) ? 'selected' : '';
                             ?>
                             <option value="<?php echo esc_attr($context); ?>" <?php echo esc_attr($checked); ?>>
-                                <?php echo $context_details[ $context ]['label']; // already escaped
+                                <?php echo $context_details[$context]['label']; // already escaped
                                 ?>
                             </option>
                         <?php endforeach;
@@ -3077,7 +3077,7 @@ 
     {
         if (is_array($content)) {
             foreach ($content as $key => $value) {
-                $content[ $key ] = $this->sanitizeMessageTemplateContent($value);
+                $content[$key] = $this->sanitizeMessageTemplateContent($value);
             }
             return $content;
         }
@@ -3115,7 +3115,7 @@ 
 
         $context   = ucwords(str_replace('_', ' ', $context));
         $item_desc = $messenger_label && $message_type_label
-            ? $messenger_label . ' ' . $message_type_label . ' ' . $context . ' '
+            ? $messenger_label.' '.$message_type_label.' '.$context.' '
             : '';
         $item_desc .= 'Message Template';
         return $item_desc;
@@ -3267,7 +3267,7 @@ 
         if ($all) {
             // Checkboxes
             $checkboxes = $this->request->getRequestParam('checkbox', [], 'int', true);
-            if (! empty($checkboxes)) {
+            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;
@@ -3277,18 +3277,18 @@ 
                     $trashed_or_restored = $trash
                         ? $this->getMtgModel()->delete_by_ID($GRP_ID)
                         : $this->getMtgModel()->restore_by_ID($GRP_ID);
-                    if (! $trashed_or_restored) {
+                    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)) {
+                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) {
+                    if ( ! $trashed_or_restored) {
                         $success = 0;
                     }
                 } else {
@@ -3336,7 +3336,7 @@ 
 
         // checkboxes
         $checkboxes = $this->request->getRequestParam('checkbox', [], 'int', true);
-        if (! empty($checkboxes)) {
+        if ( ! empty($checkboxes)) {
             // if array has more than one element then success message should be plural
             $success = count($checkboxes) > 1 ? 2 : 1;
 
@@ -3440,7 +3440,7 @@ 
     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)) {
+        if ( ! empty($this->_m_mt_settings)) {
             return;
         }
 
@@ -3452,7 +3452,7 @@ 
         // assemble the array for the _tab_text_links helper
 
         foreach ($messengers as $messenger) {
-            $this->_m_mt_settings['messenger_tabs'][ $messenger->name ] = [
+            $this->_m_mt_settings['messenger_tabs'][$messenger->name] = [
                 'label' => ucwords($messenger->label['singular']),
                 'class' => $this->_message_resource_manager->is_messenger_active($messenger->name)
                     ? 'messenger-active'
@@ -3469,7 +3469,7 @@ 
             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)) {
+                if ( ! in_array($message_type->name, $message_types_for_messenger, true)) {
                     continue;
                 }
 
@@ -3480,12 +3480,12 @@ 
                     ? 'active'
                     : 'inactive';
 
-                $this->_m_mt_settings['message_type_tabs'][ $messenger->name ][ $a_or_i ][ $message_type->name ] = [
+                $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',
+                    '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'),
@@ -3516,25 +3516,25 @@ 
         $fields                                         = $message_type->get_admin_settings_fields();
         $settings_template_args['template_form_fields'] = '';
 
-        if (! empty($fields) && $active) {
+        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 . ']',
+                $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 ]
+                    'value'      => isset($existing_settings[$fldname])
+                        ? $existing_settings[$fldname]
                         : $fldprops['default'],
                     'options'    => isset($fldprops['options'])
                         ? $fldprops['options']
                         : [],
-                    'default'    => isset($existing_settings[ $fldname ])
-                        ? $existing_settings[ $fldname ]
+                    'default'    => isset($existing_settings[$fldname])
+                        ? $existing_settings[$fldname]
                         : $fldprops['default'],
                     'css_class'  => 'no-drag',
                     'format'     => $fldprops['format'],
@@ -3554,15 +3554,15 @@ 
         $settings_template_args['description'] = $message_type->description;
         // we also need some hidden fields
         $hidden_fields = [
-            'message_type_settings[messenger]' . $message_type->name    => [
+            'message_type_settings[messenger]'.$message_type->name    => [
                 'type'  => 'hidden',
                 'value' => $messenger->name,
             ],
-            'message_type_settings[message_type]' . $message_type->name => [
+            'message_type_settings[message_type]'.$message_type->name => [
                 'type'  => 'hidden',
                 'value' => $message_type->name,
             ],
-            'type' . $message_type->name                                => [
+            'type'.$message_type->name                                => [
                 'type'  => 'hidden',
                 'value' => 'message_type',
             ],
@@ -3572,12 +3572,12 @@ 
             $hidden_fields,
             'array'
         );
-        $settings_template_args['show_form']     = empty($settings_template_args['template_form_fields'])
+        $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';
+        $template = EE_MSG_TEMPLATE_PATH.'ee_msg_mt_settings_content.template.php';
         return EEH_Template::display_template($template, $settings_template_args, true);
     }
 
@@ -3605,21 +3605,21 @@ 
 
                 // 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']
+                $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(
+                $m_boxes[$messenger.'_a_box'] = sprintf(
                     esc_html__('%s Settings', 'event_espresso'),
                     $tab_array['label']
                 );
 
-                $m_template_args[ $messenger . '_a_box' ] = [
+                $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->_m_mt_settings['message_type_tabs'][$messenger]['inactive']
                     )
-                        ? $this->_get_mt_tabs($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',
@@ -3631,13 +3631,13 @@ 
                 // 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' ] = [
+                $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->_m_mt_settings['message_type_tabs'][$messenger]['inactive']
                     )
-                        ? $this->_get_mt_tabs($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,
@@ -3650,14 +3650,14 @@ 
 
 
         // register messenger metaboxes
-        $m_template_path = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_messenger_mt_meta_box.template.php';
+        $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 ]];
+            $callback_args = ['template_path' => $m_template_path, 'template_args' => $m_template_args[$box]];
             $msgr          = str_replace('_a_box', '', $box);
             add_meta_box(
-                'espresso_' . $msgr . '_settings',
+                'espresso_'.$msgr.'_settings',
                 $label,
-                function ($post, $metabox) {
+                function($post, $metabox) {
                     EEH_Template::display_template(
                         $metabox['args']['template_path'],
                         $metabox['args']['template_args']
@@ -3671,17 +3671,17 @@ 
         }
 
         // register message type metaboxes
-        $mt_template_path = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_messenger_meta_box.template.php';
+        $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 ],
+                'template_args' => $mt_template_args[$box],
             ];
-            $mt            = str_replace('_i_box', '', $box);
+            $mt = str_replace('_i_box', '', $box);
             add_meta_box(
-                'espresso_' . $mt . '_inactive_mts',
+                'espresso_'.$mt.'_inactive_mts',
                 $label,
-                function ($post, $metabox) {
+                function($post, $metabox) {
                     EEH_Template::display_template(
                         $metabox['args']['template_path'],
                         $metabox['args']['template_args']
@@ -3826,7 +3826,7 @@ 
             if ($form->is_valid()) {
                 $valid_data = $form->valid_data();
                 foreach ($valid_data as $property => $value) {
-                    $setter = 'set_' . $property;
+                    $setter = 'set_'.$property;
                     if (method_exists($network_config, $setter)) {
                         $network_config->{$setter}($value);
                     } elseif (
@@ -3862,7 +3862,7 @@ 
     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';
+        $template  = EE_MSG_TEMPLATE_PATH.'ee_msg_details_mt_settings_tab_item.template.php';
         $tabs      = '';
 
         foreach ($tab_array as $tab) {
@@ -3890,20 +3890,20 @@ 
         $settings_template_args['active'] = $this->_message_resource_manager->is_messenger_active($messenger->name);
 
 
-        if (! empty($fields)) {
+        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 . ']',
+                $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 ]
+                    'value'      => isset($existing_settings[$field_id])
+                        ? $existing_settings[$field_id]
                         : $fldprops['default'],
                     'css_class'  => '',
                     'format'     => $fldprops['format'],
@@ -3918,20 +3918,20 @@ 
 
         // we also need some hidden fields
         $settings_template_args['hidden_fields'] = [
-            'messenger_settings[messenger]' . $messenger->name => [
+            'messenger_settings[messenger]'.$messenger->name => [
                 'type'  => 'hidden',
                 'value' => $messenger->name,
             ],
-            'type' . $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 . ']' ] = [
+        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,
                 ];
@@ -3941,7 +3941,7 @@ 
             $settings_template_args['hidden_fields'],
             'array'
         );
-        $active                                  =
+        $active =
             $this->_message_resource_manager->is_messenger_active($messenger->name);
 
         $settings_template_args['messenger']           = $messenger->name;
@@ -3961,9 +3961,9 @@ 
 
 
         $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['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';
+        $template                                = EE_MSG_TEMPLATE_PATH.'ee_msg_m_settings_content.template.php';
         return EEH_Template::display_template(
             $template,
             $settings_template_args,
@@ -3988,7 +3988,7 @@ 
         $this->_prep_default_response_for_messenger_or_message_type_toggle();
         // let's check that we have required data
 
-        if (! $this->_active_messenger_name) {
+        if ( ! $this->_active_messenger_name) {
             EE_Error::add_error(
                 esc_html__('Messenger name needed to toggle activation. None given', 'event_espresso'),
                 __FILE__,
@@ -4006,7 +4006,7 @@ 
 
 
         $status = $this->request->getRequestParam('status');
-        if (! $status) {
+        if ( ! $status) {
             EE_Error::add_error(
                 esc_html__(
                     'Messenger status needed to know whether activation or deactivation is happening. No status is given',
@@ -4063,7 +4063,7 @@ 
         $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) {
+        if ( ! $this->_active_message_type_name) {
             EE_Error::add_error(
                 esc_html__('Message Type name needed to toggle activation. None given', 'event_espresso'),
                 __FILE__,
@@ -4073,7 +4073,7 @@ 
             $success = false;
         }
 
-        if (! $this->_active_messenger_name) {
+        if ( ! $this->_active_messenger_name) {
             EE_Error::add_error(
                 esc_html__('Messenger name needed to toggle activation. None given', 'event_espresso'),
                 __FILE__,
@@ -4084,7 +4084,7 @@ 
         }
 
         $status = $this->request->getRequestParam('status');
-        if (! $status) {
+        if ( ! $status) {
             EE_Error::add_error(
                 esc_html__(
                     'Messenger status needed to know whether activation or deactivation is happening. No status is given',
@@ -4296,7 +4296,7 @@ 
         EE_Message_Type $message_type = null
     ) {
         // if $messenger isn't a valid messenger object then get out.
-        if (! $messenger instanceof EE_Messenger) {
+        if ( ! $messenger instanceof EE_Messenger) {
             EE_Error::add_error(
                 esc_html__('The messenger being activated is not a valid messenger', 'event_espresso'),
                 __FILE__,
@@ -4350,7 +4350,7 @@ 
             // 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()) {
+            if ( ! $messenger->get_default_message_types()) {
                 // messenger doesn't have any default message types so still a success.
                 EE_Error::add_success(
                     sprintf(
@@ -4406,7 +4406,7 @@ 
         EE_Error::overwrite_success();
 
         // if $messenger isn't a valid messenger object then get out.
-        if (! $messenger instanceof EE_Messenger) {
+        if ( ! $messenger instanceof EE_Messenger) {
             EE_Error::add_error(
                 esc_html__('The messenger being deactivated is not a valid messenger', 'event_espresso'),
                 __FILE__,
@@ -4476,7 +4476,7 @@ 
      */
     public function update_mt_form()
     {
-        if (! $this->_active_messenger_name || ! $this->_active_message_type_name) {
+        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__,
@@ -4487,7 +4487,7 @@ 
         }
 
         $message_types = $this->get_installed_message_types();
-        $message_type  = $message_types[ $this->_active_message_type_name ];
+        $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);
 
@@ -4506,7 +4506,7 @@ 
     public function save_settings()
     {
         $type = $this->request->getRequestParam('type');
-        if (! $type) {
+        if ( ! $type) {
             EE_Error::add_error(
                 esc_html__(
                     'Cannot save settings because type is unknown (messenger settings or message type settings?)',

Indentation +4640 added lines, -4640 removed lines

@@ -16,2683 +16,2683 @@ 
  */
 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'),
-                    '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'),
-                    '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'),
-                    'order' => 30,
-                ],
-                'help_tabs'     => [],
-                'require_nonce' => false,
-            ],
-            'add_new_message_template' => [
-                'nav'           => [
-                    'label'      => esc_html__('Add New Message Templates', 'event_espresso'),
-                    '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'),
-                    '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'),
-                    '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'),
-                    '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="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());
-        $this->_template_args['before_list_table'] = '<h3>'
-                                                     . $this->getMsgModel()->get_pretty_label_for_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-legend-' . EEM_Message::status_sent,
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_sent, false, 'sentence'),
-            ],
-            'idle_status'                => [
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_idle,
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_idle, false, 'sentence'),
-            ],
-            'failed_status'              => [
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_failed,
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_failed, false, 'sentence'),
-            ],
-            'messenger_executing_status' => [
-                'class' => 'ee-status-legend ee-status-legend-' . 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-legend-' . EEM_Message::status_resend,
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_resend, false, 'sentence'),
-            ],
-            'incomplete_status'          => [
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_incomplete,
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_incomplete, false, 'sentence'),
-            ],
-            'retry_status'               => [
-                'class' => 'ee-status-legend ee-status-legend-' . 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-legend-' . 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'] = $this->add_context_switcher();
-        $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_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()
-    {
-        add_meta_box(
-            'mtp_valid_shortcodes',
-            esc_html__('Valid Shortcodes', 'event_espresso'),
-            [$this, 'shortcode_meta_box'],
-            $this->_current_screen->id,
-            'side'
-        );
-        add_meta_box(
-            'mtp_extra_actions',
-            esc_html__('Extra Actions', 'event_espresso'),
-            [$this, 'extra_actions_meta_box'],
-            $this->_current_screen->id,
-            'side',
-            'high'
-        );
-        add_meta_box(
-            '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 .= '<p>';
-        $test_settings_html .= esc_html__('Need to reset this message type and start over?', 'event_espresso');
-        $test_settings_html .= '</p>';
-        $test_settings_html .= '<div class="publishing-action alignright resetbutton">';
-        $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 $test_settings_html; // already escaped
-    }
-
-
-    /**
-     * 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'),
+					'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'),
+					'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'),
+					'order' => 30,
+				],
+				'help_tabs'     => [],
+				'require_nonce' => false,
+			],
+			'add_new_message_template' => [
+				'nav'           => [
+					'label'      => esc_html__('Add New Message Templates', 'event_espresso'),
+					'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'),
+					'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'),
+					'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'),
+					'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="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());
+		$this->_template_args['before_list_table'] = '<h3>'
+													 . $this->getMsgModel()->get_pretty_label_for_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-legend-' . EEM_Message::status_sent,
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_sent, false, 'sentence'),
+			],
+			'idle_status'                => [
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_idle,
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_idle, false, 'sentence'),
+			],
+			'failed_status'              => [
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_failed,
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_failed, false, 'sentence'),
+			],
+			'messenger_executing_status' => [
+				'class' => 'ee-status-legend ee-status-legend-' . 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-legend-' . EEM_Message::status_resend,
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_resend, false, 'sentence'),
+			],
+			'incomplete_status'          => [
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_incomplete,
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_incomplete, false, 'sentence'),
+			],
+			'retry_status'               => [
+				'class' => 'ee-status-legend ee-status-legend-' . 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-legend-' . 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'] = $this->add_context_switcher();
+		$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_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()
+	{
+		add_meta_box(
+			'mtp_valid_shortcodes',
+			esc_html__('Valid Shortcodes', 'event_espresso'),
+			[$this, 'shortcode_meta_box'],
+			$this->_current_screen->id,
+			'side'
+		);
+		add_meta_box(
+			'mtp_extra_actions',
+			esc_html__('Extra Actions', 'event_espresso'),
+			[$this, 'extra_actions_meta_box'],
+			$this->_current_screen->id,
+			'side',
+			'high'
+		);
+		add_meta_box(
+			'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 .= '<p>';
+		$test_settings_html .= esc_html__('Need to reset this message type and start over?', 'event_espresso');
+		$test_settings_html .= '</p>';
+		$test_settings_html .= '<div class="publishing-action alignright resetbutton">';
+		$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 $test_settings_html; // already escaped
+	}
+
+
+	/**
+	 * 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 $this->_get_help_tab_link('message_template_shortcodes'); // already escaped
-            ?>
+			?>
         </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-menu"></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-menu"></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 absint($id); ?>' class='screen-reader-text'>
                     <?php esc_html_e('message context options', 'event_espresso'); ?>
                 </label>
                 <select id="<?php echo absint($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 $context_details[ $context ]['label']; // already escaped
-                                ?>
+								?>
                             </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"
@@ -2700,1995 +2700,1995 @@ 
                 />
             </form>
             <?php echo $args['extra']; // already escaped
-            ?>
+			?>
         </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.
-        list($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) {
-            $this->_m_mt_settings['messenger_tabs'][ $messenger->name ] = [
-                'label' => ucwords($messenger->label['singular']),
-                'class' => $this->_message_resource_manager->is_messenger_active($messenger->name)
-                    ? 'messenger-active'
-                    : '',
-                'href'  => $messenger->name,
-                'title' => esc_html__('Modify this Messenger', 'event_espresso'),
-                'slug'  => $messenger->name,
-                'obj'   => $messenger,
-            ];
-
-
-            $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);
-            add_meta_box(
-                '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);
-            add_meta_box(
-                '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()) {
-            add_meta_box(
-                '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();
-        // already escaped
-        echo $form->form_open(
-            $this->add_query_args_and_nonce(['action' => 'update_global_settings'], EE_MSG_ADMIN_URL),
-            'POST'
-        );
-        echo $form->get_html();
-        echo $form->form_close();
-    }
-
-
-    /**
-     * 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' => '&nbsp',
-                            ]
-                        ),
-                    ]
-                ),
-            ]
-        );
-    }
-
-
-    /**
-     * 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);
-    }
+		$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.
+		list($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) {
+			$this->_m_mt_settings['messenger_tabs'][ $messenger->name ] = [
+				'label' => ucwords($messenger->label['singular']),
+				'class' => $this->_message_resource_manager->is_messenger_active($messenger->name)
+					? 'messenger-active'
+					: '',
+				'href'  => $messenger->name,
+				'title' => esc_html__('Modify this Messenger', 'event_espresso'),
+				'slug'  => $messenger->name,
+				'obj'   => $messenger,
+			];
+
+
+			$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);
+			add_meta_box(
+				'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);
+			add_meta_box(
+				'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()) {
+			add_meta_box(
+				'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();
+		// already escaped
+		echo $form->form_open(
+			$this->add_query_args_and_nonce(['action' => 'update_global_settings'], EE_MSG_ADMIN_URL),
+			'POST'
+		);
+		echo $form->get_html();
+		echo $form->form_close();
+	}
+
+
+	/**
+	 * 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' => '&nbsp',
+							]
+						),
+					]
+				),
+			]
+		);
+	}
+
+
+	/**
+	 * 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/venues/Venues_Admin_Page.core.php

Indentation +1556 added lines, -1556 removed lines

@@ -14,1566 +14,1566 @@
 class Venues_Admin_Page extends EE_Admin_Page_CPT
 {
 
-    /**
-     * _venue
-     * This will hold the venue object for venue_details screen.
-     *
-     * @access protected
-     * @var object
-     */
-    protected $_venue;
-
-
-    /**
-     * This will hold the category object for category_details screen.
-     *
-     * @var object
-     */
-    protected $_category;
-
-
-    /**
-     * This property will hold the venue model instance
-     *
-     * @var object
-     */
-    protected $_venue_model;
-
-
-    /**
-     * @throws EE_Error
-     */
-    protected function _init_page_props()
-    {
-        require_once(EE_MODELS . 'EEM_Venue.model.php');
-        $this->page_slug        = EE_VENUES_PG_SLUG;
-        $this->_admin_base_url  = EE_VENUES_ADMIN_URL;
-        $this->_admin_base_path = EE_ADMIN_PAGES . 'venues';
-        $this->page_label       = esc_html__('Event Venues', 'event_espresso');
-        $this->_cpt_model_names = [
-            'create_new' => 'EEM_Venue',
-            'edit'       => 'EEM_Venue',
-        ];
-        $this->_cpt_edit_routes = [
-            'espresso_venues' => 'edit',
-        ];
-        $this->_venue_model     = EEM_Venue::instance();
-    }
-
-
-    protected function _ajax_hooks()
-    {
-        // todo: all hooks for ee_venues ajax goes in here.
-    }
-
-
-    protected function _define_page_props()
-    {
-        $this->_admin_page_title = $this->page_label;
-        $this->_labels           = [
-            'buttons'      => [
-                'add'             => esc_html__('Add New Venue', 'event_espresso'),
-                'edit'            => esc_html__('Edit Venue', 'event_espresso'),
-                'delete'          => esc_html__('Delete Venue', '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_venues' => esc_html__('Enter Venue name here', 'event_espresso'),
-            ],
-            'publishbox'   => [
-                'create_new'          => esc_html__('Save New Venue', 'event_espresso'),
-                'edit'                => esc_html__('Update Venue', 'event_espresso'),
-                'add_category'        => esc_html__('Save New Category', 'event_espresso'),
-                'edit_category'       => esc_html__('Update Category', 'event_espresso'),
-                'google_map_settings' => esc_html__('Update Settings', 'event_espresso'),
-            ],
-        ];
-    }
-
-
-    protected function _set_page_routes()
-    {
-
-        // load formatter helper
-        // load field generator helper
-
-        // is there a vnu_id in the request?
-        $VNU_ID = $this->request->getRequestParam('VNU_ID', 0, 'int');
-        $VNU_ID = $this->request->getRequestParam('post', $VNU_ID, 'int');
-
-        $this->_page_routes = [
-            'default'                    => [
-                'func'       => '_overview_list_table',
-                'capability' => 'ee_read_venues',
-            ],
-            'create_new'                 => [
-                'func'       => '_create_new_cpt_item',
-                'capability' => 'ee_edit_venues',
-            ],
-            'edit'                       => [
-                'func'       => '_edit_cpt_item',
-                'capability' => 'ee_edit_venue',
-                'obj_id'     => $VNU_ID,
-            ],
-            'trash_venue'                => [
-                'func'       => '_trash_or_restore_venue',
-                'args'       => ['venue_status' => 'trash'],
-                'noheader'   => true,
-                'capability' => 'ee_delete_venue',
-                'obj_id'     => $VNU_ID,
-            ],
-            'trash_venues'               => [
-                'func'       => '_trash_or_restore_venues',
-                'args'       => ['venue_status' => 'trash'],
-                'noheader'   => true,
-                'capability' => 'ee_delete_venues',
-            ],
-            'restore_venue'              => [
-                'func'       => '_trash_or_restore_venue',
-                'args'       => ['venue_status' => 'draft'],
-                'noheader'   => true,
-                'capability' => 'ee_delete_venue',
-                'obj_id'     => $VNU_ID,
-            ],
-            'restore_venues'             => [
-                'func'       => '_trash_or_restore_venues',
-                'args'       => ['venue_status' => 'draft'],
-                'noheader'   => true,
-                'capability' => 'ee_delete_venues',
-            ],
-            'delete_venues'              => [
-                'func'       => '_delete_venues',
-                'noheader'   => true,
-                'capability' => 'ee_delete_venues',
-            ],
-            'delete_venue'               => [
-                'func'       => '_delete_venue',
-                'noheader'   => true,
-                'capability' => 'ee_delete_venue',
-                'obj_id'     => $VNU_ID,
-            ],
-            // settings related
-            'google_map_settings'        => [
-                'func'       => '_google_map_settings',
-                'capability' => 'manage_options',
-            ],
-            'update_google_map_settings' => [
-                'func'       => '_update_google_map_settings',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ],
-            // venue category tab related
-            'add_category'               => [
-                'func'       => '_category_details',
-                'args'       => ['add'],
-                'capability' => 'ee_edit_venue_category',
-            ],
-            'edit_category'              => [
-                'func'       => '_category_details',
-                'args'       => ['edit'],
-                'capability' => 'ee_edit_venue_category',
-            ],
-            'delete_categories'          => [
-                'func'       => '_delete_categories',
-                'noheader'   => true,
-                'capability' => 'ee_delete_venue_category',
-            ],
-
-            'delete_category' => [
-                'func'       => '_delete_categories',
-                'noheader'   => true,
-                'capability' => 'ee_delete_venue_category',
-            ],
-
-            'insert_category' => [
-                'func'       => '_insert_or_update_category',
-                'args'       => ['new_category' => true],
-                'noheader'   => true,
-                'capability' => 'ee_edit_venue_category',
-            ],
-
-            'update_category'   => [
-                'func'       => '_insert_or_update_category',
-                'args'       => ['new_category' => false],
-                'noheader'   => true,
-                'capability' => 'ee_edit_venue_category',
-            ],
-            'export_categories' => [
-                'func'       => '_categories_export',
-                'noheader'   => true,
-                'capability' => 'export',
-            ],
-            'import_categories' => [
-                'func'       => '_import_categories',
-                'capability' => 'import',
-            ],
-            'category_list'     => [
-                'func'       => '_category_list_table',
-                'capability' => 'ee_manage_venue_categories',
-            ],
-        ];
-    }
-
-
-    protected function _set_page_config()
-    {
-        $VNU_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'),
-                    'order' => 10,
-                ],
-                'list_table'    => 'Venues_Admin_List_Table',
-                'help_tabs'     => [
-                    'venues_overview_help_tab'                           => [
-                        'title'    => esc_html__('Venues Overview', 'event_espresso'),
-                        'filename' => 'venues_overview',
-                    ],
-                    'venues_overview_table_column_headings_help_tab'     => [
-                        'title'    => esc_html__('Venues Overview Table Column Headings', 'event_espresso'),
-                        'filename' => 'venues_overview_table_column_headings',
-                    ],
-                    'venues_overview_views_bulk_actions_search_help_tab' => [
-                        'title'    => esc_html__('Venues Overview Views & Bulk Actions & Search', 'event_espresso'),
-                        'filename' => 'venues_overview_views_bulk_actions_search',
-                    ],
-                ],
-                'metaboxes'     => ['_espresso_news_post_box', '_espresso_links_post_box'],
-                'require_nonce' => false,
-            ],
-            'create_new'          => [
-                'nav'           => [
-                    'label'      => esc_html__('Add Venue', 'event_espresso'),
-                    'order'      => 5,
-                    'persistent' => false,
-                ],
-                'help_tabs'     => [
-                    'venues_editor_help_tab'                                               => [
-                        'title'    => esc_html__('Venue Editor', 'event_espresso'),
-                        'filename' => 'venues_editor',
-                    ],
-                    'venues_editor_title_richtexteditor_help_tab'                          => [
-                        'title'    => esc_html__('Venue Title & Rich Text Editor', 'event_espresso'),
-                        'filename' => 'venues_editor_title_richtexteditor',
-                    ],
-                    'venues_editor_tags_categories_help_tab'                               => [
-                        'title'    => esc_html__('Venue Tags & Categories', 'event_espresso'),
-                        'filename' => 'venues_editor_tags_categories',
-                    ],
-                    'venues_editor_physical_location_google_map_virtual_location_help_tab' => [
-                        'title'    => esc_html__(
-                            'Venue Editor Physical Location & Google Map & Virtual Location',
-                            'event_espresso'
-                        ),
-                        'filename' => 'venues_editor_physical_location_google_map_virtual_location',
-                    ],
-                    'venues_editor_save_new_venue_help_tab'                                => [
-                        'title'    => esc_html__('Save New Venue', 'event_espresso'),
-                        'filename' => 'venues_editor_save_new_venue',
-                    ],
-                    'venues_editor_other_help_tab'                                         => [
-                        'title'    => esc_html__('Venue Editor Other', 'event_espresso'),
-                        'filename' => 'venues_editor_other',
-                    ],
-                ],
-                'metaboxes'     => ['_venue_editor_metaboxes'],
-                'require_nonce' => false,
-            ],
-            'edit'                => [
-                'nav'           => [
-                    'label'      => esc_html__('Edit Venue', 'event_espresso'),
-                    'order'      => 5,
-                    'persistent' => false,
-                    'url'        => $VNU_ID
-                        ? add_query_arg(['post' => $VNU_ID], $this->_current_page_view_url)
-                        : $this->_admin_base_url,
-                ],
-                'help_tabs'     => [
-                    'venues_editor_help_tab'                                               => [
-                        'title'    => esc_html__('Venue Editor', 'event_espresso'),
-                        'filename' => 'venues_editor',
-                    ],
-                    'venues_editor_title_richtexteditor_help_tab'                          => [
-                        'title'    => esc_html__('Venue Title & Rich Text Editor', 'event_espresso'),
-                        'filename' => 'venues_editor_title_richtexteditor',
-                    ],
-                    'venues_editor_tags_categories_help_tab'                               => [
-                        'title'    => esc_html__('Venue Tags & Categories', 'event_espresso'),
-                        'filename' => 'venues_editor_tags_categories',
-                    ],
-                    'venues_editor_physical_location_google_map_virtual_location_help_tab' => [
-                        'title'    => esc_html__(
-                            'Venue Editor Physical Location & Google Map & Virtual Location',
-                            'event_espresso'
-                        ),
-                        'filename' => 'venues_editor_physical_location_google_map_virtual_location',
-                    ],
-                    'venues_editor_save_new_venue_help_tab'                                => [
-                        'title'    => esc_html__('Save New Venue', 'event_espresso'),
-                        'filename' => 'venues_editor_save_new_venue',
-                    ],
-                    'venues_editor_other_help_tab'                                         => [
-                        'title'    => esc_html__('Venue Editor Other', 'event_espresso'),
-                        'filename' => 'venues_editor_other',
-                    ],
-                ],
-                'metaboxes'     => ['_venue_editor_metaboxes'],
-                'require_nonce' => false,
-            ],
-            'google_map_settings' => [
-                'nav'           => [
-                    'label' => esc_html__('Google Maps', 'event_espresso'),
-                    'order' => 40,
-                ],
-                'metaboxes'     => array_merge($this->_default_espresso_metaboxes, ['_publish_post_box']),
-                'help_tabs'     => [
-                    'general_settings_google_maps_help_tab' => [
-                        'title'    => esc_html__('Google Maps', 'event_espresso'),
-                        'filename' => 'general_settings_google_maps',
-                    ],
-                ],
-                'require_nonce' => false,
-            ],
-            // venue category stuff
-            'add_category'        => [
-                'nav'           => [
-                    'label'      => esc_html__('Add Category', 'event_espresso'),
-                    'order'      => 15,
-                    'persistent' => false,
-                ],
-                'metaboxes'     => ['_publish_post_box'],
-                'help_tabs'     => [
-                    'venues_add_category_help_tab' => [
-                        'title'    => esc_html__('Add New Venue Category', 'event_espresso'),
-                        'filename' => 'venues_add_category',
-                    ],
-                ],
-                'require_nonce' => false,
-            ],
-            'edit_category'       => [
-                'nav'           => [
-                    'label'      => esc_html__('Edit Category', 'event_espresso'),
-                    'order'      => 15,
-                    'persistent' => false,
-                    'url'        => $EVT_CAT_ID
-                        ? add_query_arg(['EVT_CAT_ID' => $EVT_CAT_ID], $this->_current_page_view_url)
-                        : $this->_admin_base_url,
-                ],
-                'metaboxes'     => ['_publish_post_box'],
-                'help_tabs'     => [
-                    'venues_edit_category_help_tab' => [
-                        'title'    => esc_html__('Edit Venue Category', 'event_espresso'),
-                        'filename' => 'venues_edit_category',
-                    ],
-                ],
-                'require_nonce' => false,
-            ],
-            'category_list'       => [
-                'nav'           => [
-                    'label' => esc_html__('Categories', 'event_espresso'),
-                    'order' => 20,
-                ],
-                'list_table'    => 'Venue_Categories_Admin_List_Table',
-                'help_tabs'     => [
-                    'venues_categories_help_tab'                       => [
-                        'title'    => esc_html__('Venue Categories', 'event_espresso'),
-                        'filename' => 'venues_categories',
-                    ],
-                    'venues_categories_table_column_headings_help_tab' => [
-                        'title'    => esc_html__('Venue Categories Table Column Headings', 'event_espresso'),
-                        'filename' => 'venues_categories_table_column_headings',
-                    ],
-                    'venues_categories_views_help_tab'                 => [
-                        'title'    => esc_html__('Venue Categories Views', 'event_espresso'),
-                        'filename' => 'venues_categories_views',
-                    ],
-                    'venues_categories_other_help_tab'                 => [
-                        'title'    => esc_html__('Venue Categories Other', 'event_espresso'),
-                        'filename' => 'venues_categories_other',
-                    ],
-                ],
-                'metaboxes'     => $this->_default_espresso_metaboxes,
-                'require_nonce' => false,
-            ],
-        ];
-    }
-
-
-    protected function _add_screen_options()
-    {
-        // todo
-    }
-
-
-    protected function _add_screen_options_default()
-    {
-        $this->_per_page_screen_option();
-    }
-
-
-    protected function _add_screen_options_category_list()
-    {
-        $page_title              = $this->_admin_page_title;
-        $this->_admin_page_title = esc_html__('Venue Categories', 'event_espresso');
-        $this->_per_page_screen_option();
-        $this->_admin_page_title = $page_title;
-    }
-
-
-    // none of the below group are currently used for Event Venues
-    protected function _add_feature_pointers()
-    {
-    }
-
-
-    public function admin_init()
-    {
-    }
-
-
-    public function admin_notices()
-    {
-    }
-
-
-    public function admin_footer_scripts()
-    {
-    }
-
-
-    public function load_scripts_styles_create_new()
-    {
-        $this->load_scripts_styles_edit();
-    }
-
-
-    public function load_scripts_styles()
-    {
-        wp_register_style('ee-cat-admin', EVENTS_ASSETS_URL . 'ee-cat-admin.css', [], EVENT_ESPRESSO_VERSION);
-        wp_enqueue_style('ee-cat-admin');
-    }
-
-
-    public function load_scripts_styles_add_category()
-    {
-        $this->load_scripts_styles_edit_category();
-    }
-
-
-    public function load_scripts_styles_edit_category()
-    {
-    }
-
-
-    public function load_scripts_styles_edit()
-    {
-        // styles
-        wp_enqueue_style('espresso-ui-theme');
-        wp_register_style(
-            'espresso_venues',
-            EE_VENUES_ASSETS_URL . 'ee-venues-admin.css',
-            [],
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('espresso_venues');
-    }
-
-
-    protected function _set_list_table_views_default()
-    {
-        $this->_views = [
-            'all' => [
-                'slug'        => 'all',
-                'label'       => esc_html__('View All Venues', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => [],
-            ],
-        ];
-
-        if (EE_Registry::instance()->CAP->current_user_can('ee_delete_venues', 'espresso_venues_trash_venues')) {
-            $this->_views['all']['bulk_action'] = [
-                'trash_venues' => esc_html__('Move to Trash', 'event_espresso'),
-            ];
-            $this->_views['trash']              = [
-                'slug'        => 'trash',
-                'label'       => esc_html__('Trash', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => [
-                    'restore_venues' => esc_html__('Restore from Trash', 'event_espresso'),
-                    'delete_venues'  => esc_html__('Delete', 'event_espresso'),
-                ],
-            ];
-        }
-    }
-
-
-    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'),
-                ],
-            ],
-        ];
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    protected function _overview_list_table()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $this->_template_args['after_list_table'] = EEH_Template::get_button_or_link(
-            get_post_type_archive_link('espresso_venues'),
-            esc_html__("View Venue Archive Page", "event_espresso"),
-            'button'
-        );
-
-        $this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
-            'create_new',
-            'add',
-            [],
-            'add-new-h2'
-        );
-
-        $this->_search_btn_label  = esc_html__('Venues', 'event_espresso');
-        $this->display_admin_list_table_page_with_sidebar();
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function extra_misc_actions_publish_box()
-    {
-        $extra_rows = [
-            'vnu_capacity' => $this->_cpt_model_obj->get_f('VNU_capacity'),
-            'vnu_url'      => $this->_cpt_model_obj->get_f('VNU_url'),
-            'vnu_phone'    => $this->_cpt_model_obj->get_f('VNU_phone'),
-        ];
-        $template   = EE_VENUES_TEMPLATE_PATH . 'venue_publish_box_extras.template.php';
-        EEH_Template::display_template($template, $extra_rows);
-    }
-
-
-    /*************        Google Maps        *************
+	/**
+	 * _venue
+	 * This will hold the venue object for venue_details screen.
+	 *
+	 * @access protected
+	 * @var object
+	 */
+	protected $_venue;
+
+
+	/**
+	 * This will hold the category object for category_details screen.
+	 *
+	 * @var object
+	 */
+	protected $_category;
+
+
+	/**
+	 * This property will hold the venue model instance
+	 *
+	 * @var object
+	 */
+	protected $_venue_model;
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	protected function _init_page_props()
+	{
+		require_once(EE_MODELS . 'EEM_Venue.model.php');
+		$this->page_slug        = EE_VENUES_PG_SLUG;
+		$this->_admin_base_url  = EE_VENUES_ADMIN_URL;
+		$this->_admin_base_path = EE_ADMIN_PAGES . 'venues';
+		$this->page_label       = esc_html__('Event Venues', 'event_espresso');
+		$this->_cpt_model_names = [
+			'create_new' => 'EEM_Venue',
+			'edit'       => 'EEM_Venue',
+		];
+		$this->_cpt_edit_routes = [
+			'espresso_venues' => 'edit',
+		];
+		$this->_venue_model     = EEM_Venue::instance();
+	}
+
+
+	protected function _ajax_hooks()
+	{
+		// todo: all hooks for ee_venues ajax goes in here.
+	}
+
+
+	protected function _define_page_props()
+	{
+		$this->_admin_page_title = $this->page_label;
+		$this->_labels           = [
+			'buttons'      => [
+				'add'             => esc_html__('Add New Venue', 'event_espresso'),
+				'edit'            => esc_html__('Edit Venue', 'event_espresso'),
+				'delete'          => esc_html__('Delete Venue', '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_venues' => esc_html__('Enter Venue name here', 'event_espresso'),
+			],
+			'publishbox'   => [
+				'create_new'          => esc_html__('Save New Venue', 'event_espresso'),
+				'edit'                => esc_html__('Update Venue', 'event_espresso'),
+				'add_category'        => esc_html__('Save New Category', 'event_espresso'),
+				'edit_category'       => esc_html__('Update Category', 'event_espresso'),
+				'google_map_settings' => esc_html__('Update Settings', 'event_espresso'),
+			],
+		];
+	}
+
+
+	protected function _set_page_routes()
+	{
+
+		// load formatter helper
+		// load field generator helper
+
+		// is there a vnu_id in the request?
+		$VNU_ID = $this->request->getRequestParam('VNU_ID', 0, 'int');
+		$VNU_ID = $this->request->getRequestParam('post', $VNU_ID, 'int');
+
+		$this->_page_routes = [
+			'default'                    => [
+				'func'       => '_overview_list_table',
+				'capability' => 'ee_read_venues',
+			],
+			'create_new'                 => [
+				'func'       => '_create_new_cpt_item',
+				'capability' => 'ee_edit_venues',
+			],
+			'edit'                       => [
+				'func'       => '_edit_cpt_item',
+				'capability' => 'ee_edit_venue',
+				'obj_id'     => $VNU_ID,
+			],
+			'trash_venue'                => [
+				'func'       => '_trash_or_restore_venue',
+				'args'       => ['venue_status' => 'trash'],
+				'noheader'   => true,
+				'capability' => 'ee_delete_venue',
+				'obj_id'     => $VNU_ID,
+			],
+			'trash_venues'               => [
+				'func'       => '_trash_or_restore_venues',
+				'args'       => ['venue_status' => 'trash'],
+				'noheader'   => true,
+				'capability' => 'ee_delete_venues',
+			],
+			'restore_venue'              => [
+				'func'       => '_trash_or_restore_venue',
+				'args'       => ['venue_status' => 'draft'],
+				'noheader'   => true,
+				'capability' => 'ee_delete_venue',
+				'obj_id'     => $VNU_ID,
+			],
+			'restore_venues'             => [
+				'func'       => '_trash_or_restore_venues',
+				'args'       => ['venue_status' => 'draft'],
+				'noheader'   => true,
+				'capability' => 'ee_delete_venues',
+			],
+			'delete_venues'              => [
+				'func'       => '_delete_venues',
+				'noheader'   => true,
+				'capability' => 'ee_delete_venues',
+			],
+			'delete_venue'               => [
+				'func'       => '_delete_venue',
+				'noheader'   => true,
+				'capability' => 'ee_delete_venue',
+				'obj_id'     => $VNU_ID,
+			],
+			// settings related
+			'google_map_settings'        => [
+				'func'       => '_google_map_settings',
+				'capability' => 'manage_options',
+			],
+			'update_google_map_settings' => [
+				'func'       => '_update_google_map_settings',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			],
+			// venue category tab related
+			'add_category'               => [
+				'func'       => '_category_details',
+				'args'       => ['add'],
+				'capability' => 'ee_edit_venue_category',
+			],
+			'edit_category'              => [
+				'func'       => '_category_details',
+				'args'       => ['edit'],
+				'capability' => 'ee_edit_venue_category',
+			],
+			'delete_categories'          => [
+				'func'       => '_delete_categories',
+				'noheader'   => true,
+				'capability' => 'ee_delete_venue_category',
+			],
+
+			'delete_category' => [
+				'func'       => '_delete_categories',
+				'noheader'   => true,
+				'capability' => 'ee_delete_venue_category',
+			],
+
+			'insert_category' => [
+				'func'       => '_insert_or_update_category',
+				'args'       => ['new_category' => true],
+				'noheader'   => true,
+				'capability' => 'ee_edit_venue_category',
+			],
+
+			'update_category'   => [
+				'func'       => '_insert_or_update_category',
+				'args'       => ['new_category' => false],
+				'noheader'   => true,
+				'capability' => 'ee_edit_venue_category',
+			],
+			'export_categories' => [
+				'func'       => '_categories_export',
+				'noheader'   => true,
+				'capability' => 'export',
+			],
+			'import_categories' => [
+				'func'       => '_import_categories',
+				'capability' => 'import',
+			],
+			'category_list'     => [
+				'func'       => '_category_list_table',
+				'capability' => 'ee_manage_venue_categories',
+			],
+		];
+	}
+
+
+	protected function _set_page_config()
+	{
+		$VNU_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'),
+					'order' => 10,
+				],
+				'list_table'    => 'Venues_Admin_List_Table',
+				'help_tabs'     => [
+					'venues_overview_help_tab'                           => [
+						'title'    => esc_html__('Venues Overview', 'event_espresso'),
+						'filename' => 'venues_overview',
+					],
+					'venues_overview_table_column_headings_help_tab'     => [
+						'title'    => esc_html__('Venues Overview Table Column Headings', 'event_espresso'),
+						'filename' => 'venues_overview_table_column_headings',
+					],
+					'venues_overview_views_bulk_actions_search_help_tab' => [
+						'title'    => esc_html__('Venues Overview Views & Bulk Actions & Search', 'event_espresso'),
+						'filename' => 'venues_overview_views_bulk_actions_search',
+					],
+				],
+				'metaboxes'     => ['_espresso_news_post_box', '_espresso_links_post_box'],
+				'require_nonce' => false,
+			],
+			'create_new'          => [
+				'nav'           => [
+					'label'      => esc_html__('Add Venue', 'event_espresso'),
+					'order'      => 5,
+					'persistent' => false,
+				],
+				'help_tabs'     => [
+					'venues_editor_help_tab'                                               => [
+						'title'    => esc_html__('Venue Editor', 'event_espresso'),
+						'filename' => 'venues_editor',
+					],
+					'venues_editor_title_richtexteditor_help_tab'                          => [
+						'title'    => esc_html__('Venue Title & Rich Text Editor', 'event_espresso'),
+						'filename' => 'venues_editor_title_richtexteditor',
+					],
+					'venues_editor_tags_categories_help_tab'                               => [
+						'title'    => esc_html__('Venue Tags & Categories', 'event_espresso'),
+						'filename' => 'venues_editor_tags_categories',
+					],
+					'venues_editor_physical_location_google_map_virtual_location_help_tab' => [
+						'title'    => esc_html__(
+							'Venue Editor Physical Location & Google Map & Virtual Location',
+							'event_espresso'
+						),
+						'filename' => 'venues_editor_physical_location_google_map_virtual_location',
+					],
+					'venues_editor_save_new_venue_help_tab'                                => [
+						'title'    => esc_html__('Save New Venue', 'event_espresso'),
+						'filename' => 'venues_editor_save_new_venue',
+					],
+					'venues_editor_other_help_tab'                                         => [
+						'title'    => esc_html__('Venue Editor Other', 'event_espresso'),
+						'filename' => 'venues_editor_other',
+					],
+				],
+				'metaboxes'     => ['_venue_editor_metaboxes'],
+				'require_nonce' => false,
+			],
+			'edit'                => [
+				'nav'           => [
+					'label'      => esc_html__('Edit Venue', 'event_espresso'),
+					'order'      => 5,
+					'persistent' => false,
+					'url'        => $VNU_ID
+						? add_query_arg(['post' => $VNU_ID], $this->_current_page_view_url)
+						: $this->_admin_base_url,
+				],
+				'help_tabs'     => [
+					'venues_editor_help_tab'                                               => [
+						'title'    => esc_html__('Venue Editor', 'event_espresso'),
+						'filename' => 'venues_editor',
+					],
+					'venues_editor_title_richtexteditor_help_tab'                          => [
+						'title'    => esc_html__('Venue Title & Rich Text Editor', 'event_espresso'),
+						'filename' => 'venues_editor_title_richtexteditor',
+					],
+					'venues_editor_tags_categories_help_tab'                               => [
+						'title'    => esc_html__('Venue Tags & Categories', 'event_espresso'),
+						'filename' => 'venues_editor_tags_categories',
+					],
+					'venues_editor_physical_location_google_map_virtual_location_help_tab' => [
+						'title'    => esc_html__(
+							'Venue Editor Physical Location & Google Map & Virtual Location',
+							'event_espresso'
+						),
+						'filename' => 'venues_editor_physical_location_google_map_virtual_location',
+					],
+					'venues_editor_save_new_venue_help_tab'                                => [
+						'title'    => esc_html__('Save New Venue', 'event_espresso'),
+						'filename' => 'venues_editor_save_new_venue',
+					],
+					'venues_editor_other_help_tab'                                         => [
+						'title'    => esc_html__('Venue Editor Other', 'event_espresso'),
+						'filename' => 'venues_editor_other',
+					],
+				],
+				'metaboxes'     => ['_venue_editor_metaboxes'],
+				'require_nonce' => false,
+			],
+			'google_map_settings' => [
+				'nav'           => [
+					'label' => esc_html__('Google Maps', 'event_espresso'),
+					'order' => 40,
+				],
+				'metaboxes'     => array_merge($this->_default_espresso_metaboxes, ['_publish_post_box']),
+				'help_tabs'     => [
+					'general_settings_google_maps_help_tab' => [
+						'title'    => esc_html__('Google Maps', 'event_espresso'),
+						'filename' => 'general_settings_google_maps',
+					],
+				],
+				'require_nonce' => false,
+			],
+			// venue category stuff
+			'add_category'        => [
+				'nav'           => [
+					'label'      => esc_html__('Add Category', 'event_espresso'),
+					'order'      => 15,
+					'persistent' => false,
+				],
+				'metaboxes'     => ['_publish_post_box'],
+				'help_tabs'     => [
+					'venues_add_category_help_tab' => [
+						'title'    => esc_html__('Add New Venue Category', 'event_espresso'),
+						'filename' => 'venues_add_category',
+					],
+				],
+				'require_nonce' => false,
+			],
+			'edit_category'       => [
+				'nav'           => [
+					'label'      => esc_html__('Edit Category', 'event_espresso'),
+					'order'      => 15,
+					'persistent' => false,
+					'url'        => $EVT_CAT_ID
+						? add_query_arg(['EVT_CAT_ID' => $EVT_CAT_ID], $this->_current_page_view_url)
+						: $this->_admin_base_url,
+				],
+				'metaboxes'     => ['_publish_post_box'],
+				'help_tabs'     => [
+					'venues_edit_category_help_tab' => [
+						'title'    => esc_html__('Edit Venue Category', 'event_espresso'),
+						'filename' => 'venues_edit_category',
+					],
+				],
+				'require_nonce' => false,
+			],
+			'category_list'       => [
+				'nav'           => [
+					'label' => esc_html__('Categories', 'event_espresso'),
+					'order' => 20,
+				],
+				'list_table'    => 'Venue_Categories_Admin_List_Table',
+				'help_tabs'     => [
+					'venues_categories_help_tab'                       => [
+						'title'    => esc_html__('Venue Categories', 'event_espresso'),
+						'filename' => 'venues_categories',
+					],
+					'venues_categories_table_column_headings_help_tab' => [
+						'title'    => esc_html__('Venue Categories Table Column Headings', 'event_espresso'),
+						'filename' => 'venues_categories_table_column_headings',
+					],
+					'venues_categories_views_help_tab'                 => [
+						'title'    => esc_html__('Venue Categories Views', 'event_espresso'),
+						'filename' => 'venues_categories_views',
+					],
+					'venues_categories_other_help_tab'                 => [
+						'title'    => esc_html__('Venue Categories Other', 'event_espresso'),
+						'filename' => 'venues_categories_other',
+					],
+				],
+				'metaboxes'     => $this->_default_espresso_metaboxes,
+				'require_nonce' => false,
+			],
+		];
+	}
+
+
+	protected function _add_screen_options()
+	{
+		// todo
+	}
+
+
+	protected function _add_screen_options_default()
+	{
+		$this->_per_page_screen_option();
+	}
+
+
+	protected function _add_screen_options_category_list()
+	{
+		$page_title              = $this->_admin_page_title;
+		$this->_admin_page_title = esc_html__('Venue Categories', 'event_espresso');
+		$this->_per_page_screen_option();
+		$this->_admin_page_title = $page_title;
+	}
+
+
+	// none of the below group are currently used for Event Venues
+	protected function _add_feature_pointers()
+	{
+	}
+
+
+	public function admin_init()
+	{
+	}
+
+
+	public function admin_notices()
+	{
+	}
+
+
+	public function admin_footer_scripts()
+	{
+	}
+
+
+	public function load_scripts_styles_create_new()
+	{
+		$this->load_scripts_styles_edit();
+	}
+
+
+	public function load_scripts_styles()
+	{
+		wp_register_style('ee-cat-admin', EVENTS_ASSETS_URL . 'ee-cat-admin.css', [], EVENT_ESPRESSO_VERSION);
+		wp_enqueue_style('ee-cat-admin');
+	}
+
+
+	public function load_scripts_styles_add_category()
+	{
+		$this->load_scripts_styles_edit_category();
+	}
+
+
+	public function load_scripts_styles_edit_category()
+	{
+	}
+
+
+	public function load_scripts_styles_edit()
+	{
+		// styles
+		wp_enqueue_style('espresso-ui-theme');
+		wp_register_style(
+			'espresso_venues',
+			EE_VENUES_ASSETS_URL . 'ee-venues-admin.css',
+			[],
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('espresso_venues');
+	}
+
+
+	protected function _set_list_table_views_default()
+	{
+		$this->_views = [
+			'all' => [
+				'slug'        => 'all',
+				'label'       => esc_html__('View All Venues', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => [],
+			],
+		];
+
+		if (EE_Registry::instance()->CAP->current_user_can('ee_delete_venues', 'espresso_venues_trash_venues')) {
+			$this->_views['all']['bulk_action'] = [
+				'trash_venues' => esc_html__('Move to Trash', 'event_espresso'),
+			];
+			$this->_views['trash']              = [
+				'slug'        => 'trash',
+				'label'       => esc_html__('Trash', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => [
+					'restore_venues' => esc_html__('Restore from Trash', 'event_espresso'),
+					'delete_venues'  => esc_html__('Delete', 'event_espresso'),
+				],
+			];
+		}
+	}
+
+
+	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'),
+				],
+			],
+		];
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	protected function _overview_list_table()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$this->_template_args['after_list_table'] = EEH_Template::get_button_or_link(
+			get_post_type_archive_link('espresso_venues'),
+			esc_html__("View Venue Archive Page", "event_espresso"),
+			'button'
+		);
+
+		$this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
+			'create_new',
+			'add',
+			[],
+			'add-new-h2'
+		);
+
+		$this->_search_btn_label  = esc_html__('Venues', 'event_espresso');
+		$this->display_admin_list_table_page_with_sidebar();
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function extra_misc_actions_publish_box()
+	{
+		$extra_rows = [
+			'vnu_capacity' => $this->_cpt_model_obj->get_f('VNU_capacity'),
+			'vnu_url'      => $this->_cpt_model_obj->get_f('VNU_url'),
+			'vnu_phone'    => $this->_cpt_model_obj->get_f('VNU_phone'),
+		];
+		$template   = EE_VENUES_TEMPLATE_PATH . 'venue_publish_box_extras.template.php';
+		EEH_Template::display_template($template, $extra_rows);
+	}
+
+
+	/*************        Google Maps        *************
      *
      * @throws EE_Error
      * @throws EE_Error
      */
 
 
-    protected function _google_map_settings()
-    {
-
-
-        $this->_template_args['values']           = $this->_yes_no_values;
-        $default_map_settings                     = new stdClass();
-        $default_map_settings->use_google_maps    = true;
-        $default_map_settings->google_map_api_key = '';
-        // for event details pages (reg page)
-        $default_map_settings->event_details_map_width    = 585;
-        // ee_map_width_single
-        $default_map_settings->event_details_map_height   = 362;
-        // ee_map_height_single
-        $default_map_settings->event_details_map_zoom     = 14;
-        // ee_map_zoom_single
-        $default_map_settings->event_details_display_nav  = true;
-        // ee_map_nav_display_single
-        $default_map_settings->event_details_nav_size     = false;
-        // ee_map_nav_size_single
-        $default_map_settings->event_details_control_type = 'default';
-        // ee_map_type_control_single
-        $default_map_settings->event_details_map_align    = 'center';
-        // ee_map_align_single
-
-        // for event list pages
-        $default_map_settings->event_list_map_width    = 300;
-        // ee_map_width
-        $default_map_settings->event_list_map_height   = 185;
-        // ee_map_height
-        $default_map_settings->event_list_map_zoom     = 12;
-        // ee_map_zoom
-        $default_map_settings->event_list_display_nav  = false;
-        // ee_map_nav_display
-        $default_map_settings->event_list_nav_size     = true;
-        // ee_map_nav_size
-        $default_map_settings->event_list_control_type = 'dropdown';
-        // ee_map_type_control
-        $default_map_settings->event_list_map_align    = 'center';
-        // ee_map_align
-
-        $this->_template_args['map_settings'] =
-            isset(EE_Registry::instance()->CFG->map_settings)
-            && ! empty(EE_Registry::instance()->CFG->map_settings)
-                ? (object) array_merge(
-                    (array) $default_map_settings,
-                    (array) EE_Registry::instance()->CFG->map_settings
-                )
-                : $default_map_settings;
-
-        $this->_set_add_edit_form_tags('update_google_map_settings');
-        $this->_set_publish_post_box_vars(null, false, false, null, false);
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            EE_VENUES_TEMPLATE_PATH . 'google_map.template.php',
-            $this->_template_args,
-            true
-        );
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    protected function _update_google_map_settings()
-    {
-        $map_settings = EE_Registry::instance()->CFG->map_settings;
-
-        $settings = [
-            'use_google_maps'            => 'int',
-            'google_map_api_key'         => 'string',
-            'event_details_map_width'    => 'int',
-            'event_details_map_zoom'     => 'int',
-            'event_details_display_nav'  => 'int',
-            'event_details_nav_size'     => 'int',
-            'event_details_control_type' => 'string',
-            'event_details_map_align'    => 'string',
-            'event_list_map_width'       => 'int',
-            'event_list_map_height'      => 'int',
-            'event_list_map_zoom'        => 'int',
-            'event_list_display_nav'     => 'int',
-            'event_list_nav_size'        => 'int',
-            'event_list_control_type'    => 'string',
-            'event_list_map_align'       => 'string',
-        ];
-
-        foreach ($settings as $setting => $type) {
-            $map_settings->{$setting} = $this->request->getRequestParam($setting, $map_settings->{$setting}, $type);
-        }
-
-        EE_Registry::instance()->CFG->map_settings = apply_filters(
-            'FHEE__Extend_General_Settings_Admin_Page___update_google_map_settings__CFG_map_settings',
-            $map_settings
-        );
-
-        $what    = 'Google Map Settings';
-        $success = $this->_update_espresso_configuration(
-            $what,
-            EE_Registry::instance()->CFG->map_settings,
-            __FILE__,
-            __FUNCTION__,
-            __LINE__
-        );
-        $this->_redirect_after_action($success, $what, 'updated', ['action' => 'google_map_settings']);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _venue_editor_metaboxes()
-    {
-        $this->verify_cpt_object();
-
-        add_meta_box(
-            'espresso_venue_address_options',
-            esc_html__('Physical Location', 'event_espresso'),
-            [$this, 'venue_address_metabox'],
-            $this->page_slug,
-            'side'
-        );
-        add_meta_box(
-            'espresso_venue_gmap_options',
-            esc_html__('Google Map', 'event_espresso'),
-            [$this, 'venue_gmap_metabox'],
-            $this->page_slug,
-            'side'
-        );
-        add_meta_box(
-            'espresso_venue_virtual_loc_options',
-            esc_html__('Virtual Location', 'event_espresso'),
-            [$this, 'venue_virtual_loc_metabox'],
-            $this->page_slug,
-            'side'
-        );
-    }
-
-
-    public function venue_gmap_metabox()
-    {
-        $template_args = [
-            'vnu_enable_for_gmap' => EEH_Form_Fields::select_input(
-                'vnu_enable_for_gmap',
-                $this->get_yes_no_values(),
-                $this->_cpt_model_obj instanceof EE_Venue ? $this->_cpt_model_obj->enable_for_gmap() : false
-            ),
-            'vnu_google_map_link' => $this->_cpt_model_obj->google_map_link(),
-        ];
-        $template      = EE_VENUES_TEMPLATE_PATH . 'venue_gmap_metabox_content.template.php';
-        EEH_Template::display_template($template, $template_args);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function venue_address_metabox()
-    {
-        $template_args['_venue'] = $this->_cpt_model_obj;
-
-        $template_args['states_dropdown']    = EEH_Form_Fields::generate_form_input(
-            new EE_Question_Form_Input(
-                EE_Question::new_instance(
-                    ['QST_display_text' => esc_html__('State', 'event_espresso'), 'QST_system' => 'state']
-                ),
-                EE_Answer::new_instance(
-                    [
-                        'ANS_value' => $this->_cpt_model_obj instanceof EE_Venue
-                            ? $this->_cpt_model_obj->state_ID()
-                            : 0,
-                    ]
-                ),
-                [
-                    'input_name'     => 'sta_id',
-                    'input_id'       => 'sta_id',
-                    'input_class'    => '',
-                    'input_prefix'   => '',
-                    'append_qstn_id' => false,
-                ]
-            )
-        );
-        $template_args['countries_dropdown'] = EEH_Form_Fields::generate_form_input(
-            new EE_Question_Form_Input(
-                EE_Question::new_instance(
-                    ['QST_display_text' => esc_html__('Country', 'event_espresso'), 'QST_system' => 'country']
-                ),
-                EE_Answer::new_instance(
-                    [
-                        'ANS_value' => $this->_cpt_model_obj instanceof EE_Venue
-                            ? $this->_cpt_model_obj->country_ID()
-                            : 0,
-                    ]
-                ),
-                [
-                    'input_name'     => 'cnt_iso',
-                    'input_id'       => 'cnt_iso',
-                    'input_class'    => '',
-                    'input_prefix'   => '',
-                    'append_qstn_id' => false,
-                ]
-            )
-        );
-
-        $template = EE_VENUES_TEMPLATE_PATH . 'venue_address_metabox_content.template.php';
-        EEH_Template::display_template($template, $template_args);
-    }
-
-
-    public function venue_virtual_loc_metabox()
-    {
-        $template_args = [
-            '_venue' => $this->_cpt_model_obj,
-        ];
-        $template      = EE_VENUES_TEMPLATE_PATH . 'venue_virtual_location_metabox_content.template.php';
-        EEH_Template::display_template($template, $template_args);
-    }
-
-
-    protected function _restore_cpt_item($post_id, $revision_id)
-    {
-        $venue_obj = $this->_venue_model->get_one_by_ID($post_id);
-
-        // meta revision restore
-        $venue_obj->restore_revision($revision_id);
-    }
-
-
-    /**
-     * Handles updates for venue cpts
-     *
-     * @param int    $post_id ID of Venue CPT
-     * @param WP_Post $post    Post object (with "blessed" WP properties)
-     * @return void
-     */
-    protected function _insert_update_cpt_item($post_id, $post)
-    {
-
-        if ($post instanceof WP_Post && $post->post_type !== 'espresso_venues') {
-            return;// get out we're not processing the saving of venues.
-        }
-
-        $wheres = [$this->_venue_model->primary_key_name() => $post_id];
-
-        $venue_values = [
-            'VNU_address'         => $this->request->getRequestParam('vnu_address'),
-            'VNU_address2'        => $this->request->getRequestParam('vnu_address2'),
-            'VNU_city'            => $this->request->getRequestParam('vnu_city'),
-            'STA_ID'              => $this->request->getRequestParam('sta_id'),
-            'CNT_ISO'             => $this->request->getRequestParam('cnt_iso'),
-            'VNU_zip'             => $this->request->getRequestParam('vnu_zip'),
-            'VNU_phone'           => $this->request->getRequestParam('vnu_phone'),
-            'VNU_capacity'        => $this->request->requestParamIsSet('vnu_capacity')
-                ? str_replace(',', '', $this->request->getRequestParam('vnu_capacity'))
-                : EE_INF,
-            'VNU_url'             => $this->request->getRequestParam('vnu_url'),
-            'VNU_virtual_phone'   => $this->request->getRequestParam('vnu_virtual_phone'),
-            'VNU_virtual_url'     => $this->request->getRequestParam('vnu_virtual_url'),
-            'VNU_enable_for_gmap' => $this->request->getRequestParam('vnu_enable_for_gmap', false, 'bool'),
-            'VNU_google_map_link' => $this->request->getRequestParam('vnu_google_map_link'),
-        ];
-
-        // update venue
-        $success = $this->_venue_model->update($venue_values, [$wheres]);
-
-        // get venue_object for other metaboxes that might be added via the filter... though it would seem to make sense to just use $this->_venue_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!
-        $get_one_where = [$this->_venue_model->primary_key_name() => $post_id, 'status' => $post->post_status];
-        $venue         = $this->_venue_model->get_one([$get_one_where]);
-
-        // notice we've applied a filter for venue metabox callbacks but we don't actually have any default venue metaboxes in use.  So this is just here for addons to more easily hook into venue saves.
-        $venue_update_callbacks = apply_filters(
-            'FHEE__Venues_Admin_Page___insert_update_cpt_item__venue_update_callbacks',
-            []
-        );
-        $att_success            = true;
-        foreach ($venue_update_callbacks as $v_callback) {
-            // if ANY of these updates fail then we want the appropriate global error message
-            $att_success = call_user_func_array($v_callback, [$venue, $this->request->requestParams()])
-                ? $att_success
-                : false;
-        }
-
-        // any errors?
-        if ($success && ! $att_success) {
-            EE_Error::add_error(
-                esc_html__(
-                    'Venue Details saved successfully but something went wrong with saving attachments.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        } elseif ($success === false) {
-            EE_Error::add_error(
-                esc_html__('Venue Details did not save successfully.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-    }
-
-
-    /**
-     * @param int $post_id
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function trash_cpt_item($post_id)
-    {
-        $this->request->setRequestParam('VNU_ID', $post_id);
-        $this->_trash_or_restore_venue('trash', false);
-    }
-
-
-    /**
-     * @param int $post_id
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function restore_cpt_item($post_id)
-    {
-        $this->request->setRequestParam('VNU_ID', $post_id);
-        $this->_trash_or_restore_venue('draft', false);
-    }
-
-
-    /**
-     * @param int $post_id
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function delete_cpt_item($post_id)
-    {
-        $this->request->setRequestParam('VNU_ID', $post_id);
-        $this->_delete_venue(false);
-    }
-
-
-    public function get_venue_object()
-    {
-        return $this->_cpt_model_obj;
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _trash_or_restore_venue($venue_status = 'trash', $redirect_after = true)
-    {
-        $VNU_ID = $this->request->getRequestParam('VNU_ID', 0, 'int');
-
-        // loop thru venues
-        if ($VNU_ID) {
-            // clean status
-            $venue_status = sanitize_key($venue_status);
-            // grab status
-            if (! empty($venue_status)) {
-                $success = $this->_change_venue_status($VNU_ID, $venue_status);
-            } else {
-                $success = false;
-                $msg     = esc_html__(
-                    'An error occurred. The venue could not be moved to the trash because a valid venue 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 venue could not be moved to the trash because a valid venue ID was not not supplied.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-        $action = $venue_status == 'trash' ? 'moved to the trash' : 'restored from the trash';
-
-        if ($redirect_after) {
-            $this->_redirect_after_action($success, 'Venue', $action, ['action' => 'default']);
-        }
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _trash_or_restore_venues($venue_status = 'trash')
-    {
-        // clean status
-        $venue_status = sanitize_key($venue_status);
-        // grab status
-        if (! empty($venue_status)) {
-            $success = true;
-            // determine the event id and set to array.
-            $VNU_IDs = $this->request->getRequestParam('venue_id', [], 'int', true);
-            // loop thru events
-            foreach ($VNU_IDs as $VNU_ID) {
-                if ($VNU_ID = absint($VNU_ID)) {
-                    $results = $this->_change_venue_status($VNU_ID, $venue_status);
-                    $success = $results !== false ? $success : false;
-                } else {
-                    $msg = sprintf(
-                        esc_html__(
-                            'An error occurred. Venue #%d could not be moved to the trash because a valid venue ID was not not supplied.',
-                            'event_espresso'
-                        ),
-                        $VNU_ID
-                    );
-                    EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-                    $success = false;
-                }
-            }
-        } else {
-            $success = false;
-            $msg     = esc_html__(
-                'An error occurred. The venue could not be moved to the trash because a valid venue 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  = $venue_status == 'trash' ? 'moved to the trash' : 'restored from the trash';
-        $this->_redirect_after_action($success, 'Venues', $action, ['action' => 'default']);
-    }
-
-
-    /**
-     * _trash_or_restore_venues
-     *
-     * //todo this is pretty much the same as the corresponding change_event_status method in Events_Admin_Page.  We
-     * should probably abstract this up to the EE_Admin_Page_CPT (or even EE_Admin_Page) and make this a common method
-     * accepting a certain number of params.
-     *
-     * @access  private
-     * @param int    $VNU_ID
-     * @param string $venue_status
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _change_venue_status($VNU_ID = 0, $venue_status = '')
-    {
-        // grab venue id
-        if (! $VNU_ID) {
-            $msg = esc_html__('An error occurred. No Venue ID or an invalid Venue ID was received.', 'event_espresso');
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-
-        $this->_cpt_model_obj = EEM_Venue::instance()->get_one_by_ID($VNU_ID);
-
-        // clean status
-        $venue_status = sanitize_key($venue_status);
-        // grab status
-        if (! $venue_status) {
-            $msg = esc_html__(
-                'An error occurred. No Venue Status or an invalid Venue Status was received.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-
-        // was event trashed or restored ?
-        switch ($venue_status) {
-            case 'draft':
-                $action = 'restored from the trash';
-                $hook   = 'AHEE_venue_restored_from_trash';
-                break;
-            case 'trash':
-                $action = 'moved to the trash';
-                $hook   = 'AHEE_venue_moved_to_trash';
-                break;
-            default:
-                $action = 'updated';
-                $hook   = false;
-        }
-        // use class to change status
-        $this->_cpt_model_obj->set_status($venue_status);
-        $success = $this->_cpt_model_obj->save();
-
-        if ($success === false) {
-            $msg = sprintf(esc_html__('An error occurred. The venue 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 bool $redirect_after
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _delete_venue($redirect_after = true)
-    {
-        // determine the venue id and set to array.
-        $VNU_ID = $this->request->getRequestParam('VNU_ID', 0, 'int');
-        $VNU_ID = $this->request->getRequestParam('post', $VNU_ID, 'int');
-
-        // loop thru venues
-        if ($VNU_ID) {
-            $success = $this->_delete_or_trash_venue($VNU_ID);
-        } else {
-            $success = false;
-            $msg     = esc_html__(
-                'An error occurred. An venue could not be deleted because a valid venue ID was not not supplied.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-        if ($redirect_after) {
-            $this->_redirect_after_action($success, 'Venue', 'deleted', ['action' => 'default']);
-        }
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _delete_venues()
-    {
-        $success = true;
-        // determine the event id and set to array.
-        $VNU_IDs = $this->request->getRequestParam('venue_id', [], 'int', true);
-        // loop thru events
-        foreach ($VNU_IDs as $VNU_ID) {
-            if ($VNU_ID = absint($VNU_ID)) {
-                $results = $this->_delete_or_trash_venue($VNU_ID);
-                $success = $results !== false ? $success : false;
-            } else {
-                $success = false;
-                $msg     = esc_html__(
-                    'An error occurred. An venue could not be deleted because a valid venue ID 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;
-        $this->_redirect_after_action(
-            $success,
-            esc_html__('Venues', 'event_espresso'),
-            esc_html__('deleted', 'event_espresso'),
-            ['action' => 'default']
-        );
-    }
-
-
-    // todo: put in parent
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _delete_or_trash_venue($VNU_ID = false)
-    {
-        // grab event id
-        if (! $VNU_ID = absint($VNU_ID)) {
-            $msg = esc_html__('An error occurred. No Venue ID or an invalid Venue ID was received.', 'event_espresso');
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-
-
-        $venue = EEM_Venue::instance()->get_one_by_ID($VNU_ID);
-        // first need to remove all term relationships
-        $venue->_remove_relations('Term_Taxonomy');
-        $success = $venue->delete_permanently();
-        // did it all go as planned ?
-        if ($success) {
-            $msg = sprintf(esc_html__('Venue ID # %d has been deleted.', 'event_espresso'), $VNU_ID);
-            EE_Error::add_success($msg);
-        } else {
-            $msg =
-                sprintf(
-                    esc_html__('An error occurred. Venue ID # %d could not be deleted.', 'event_espresso'),
-                    $VNU_ID
-                );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        do_action('AHEE__Venues_Admin_Page___delete_or_trash_venue__after_venue_deleted');
-        return true;
-    }
-
-
-
-
-    /***********/
-    /* QUERIES */
-
-
-    public function get_venues($per_page = 10, $count = false)
-    {
-
-        $orderby = $this->request->getRequestParam('orderby', '');
-
-        switch ($orderby) {
-            case 'id':
-                $orderby = 'VNU_ID';
-                break;
-
-            case 'capacity':
-                $orderby = 'VNU_capacity';
-                break;
-
-            case 'city':
-                $orderby = 'VNU_city';
-                break;
-
-            default:
-                $orderby = 'VNU_name';
-        }
-
-        $sort         = $this->request->getRequestParam('order', 'ASC');
-        $current_page = $this->request->getRequestParam('paged', 1, 'int');
-        $per_page     = ! empty($per_page) ? $per_page : 10;
-        $per_page     = $this->request->getRequestParam('perpage', $per_page, 'int');
-
-        $offset = ($current_page - 1) * $per_page;
-        $limit  = [$offset, $per_page];
-
-        $category = $this->request->getRequestParam('category');
-        $category = $category > 0 ? $category : null;
-
-        $where = [];
-
-        // only set initial status if it is in the incoming request.  Otherwise the "all" view display's all statuses.
-        $status = $this->request->getRequestParam('status');
-        if ($status && $status !== 'all') {
-            $where['status'] = $status;
-        }
-
-        $venue_status = $this->request->getRequestParam('venue_status');
-        if ($venue_status) {
-            $where['status'] = $venue_status;
-        }
-
-
-        if ($category) {
-            $where['Term_Taxonomy.taxonomy'] = 'espresso_venue_categories';
-            $where['Term_Taxonomy.term_id']  = $category;
-        }
-
-
-        if (! EE_Registry::instance()->CAP->current_user_can('ee_read_others_venues', 'get_venues')) {
-            $where['VNU_wp_user'] = get_current_user_id();
-        } else {
-            if (! EE_Registry::instance()->CAP->current_user_can('ee_read_private_venues', 'get_venues')) {
-                $where['OR'] = [
-                    'status*restrict_private' => ['!=', 'private'],
-                    'AND'                     => [
-                        'status*inclusive' => ['=', 'private'],
-                        'VNU_wp_user'      => get_current_user_id(),
-                    ],
-                ];
-            }
-        }
-
-        $search_term = $this->request->getRequestParam('s');
-        if ($search_term) {
-            $search_term = '%' . $search_term . '%';
-            $where['OR'] = [
-                'VNU_name'               => ['LIKE', $search_term],
-                'VNU_desc'               => ['LIKE', $search_term],
-                'VNU_short_desc'         => ['LIKE', $search_term],
-                'VNU_address'            => ['LIKE', $search_term],
-                'VNU_address2'           => ['LIKE', $search_term],
-                'VNU_city'               => ['LIKE', $search_term],
-                'VNU_zip'                => ['LIKE', $search_term],
-                'VNU_phone'              => ['LIKE', $search_term],
-                'VNU_url'                => ['LIKE', $search_term],
-                'VNU_virtual_phone'      => ['LIKE', $search_term],
-                'VNU_virtual_url'        => ['LIKE', $search_term],
-                'VNU_google_map_link'    => ['LIKE', $search_term],
-                'Event.EVT_name'         => ['LIKE', $search_term],
-                'Event.EVT_desc'         => ['LIKE', $search_term],
-                'Event.EVT_phone'        => ['LIKE', $search_term],
-                'Event.EVT_external_URL' => ['LIKE', $search_term],
-            ];
-        }
-
-
-        return $count
-            ? $this->_venue_model->count([$where], 'VNU_ID')
-            : $this->_venue_model->get_all(
-                [$where, 'limit' => $limit, 'order_by' => $orderby, 'order' => $sort]
-            );
-    }
-
-
-
-
-    /** Venue 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('VEN_CAT_ID', 0, 'int');
-        if (! $category_ID) {
-            return;
-        }
-
-        $term = get_term($category_ID, 'espresso_venue_categories');
-
-
-        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;
-        }
-    }
-
-
-    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 EE_Error
-     */
-    protected function _category_list_table()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
-            'add_category',
-            'add_category',
-            [],
-            'add-new-h2'
-        );
-        $this->_search_btn_label = esc_html__('Venue Categories', 'event_espresso');
-        $this->display_admin_list_table_page_with_sidebar();
-    }
-
-
-    /**
-     * @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';
-
-        $redirect = EE_Admin_Page::add_query_args_and_nonce(['action' => 'category_list'], $this->_admin_base_url);
-
-        $this->_set_publish_post_box_vars('VEN_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();
-    }
-
-
-    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(
-            ['espresso_venue_categories'],
-            ['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);
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    protected function _delete_categories()
-    {
-        $category_ID  = $this->request->getRequestParam('category_id', 0, 'int');
-        $category_IDs = $this->request->getRequestParam('VEN_CAT_ID', [$category_ID], 'int', true);
-
-        foreach ($category_IDs as $cat_id) {
-            $this->_delete_category($cat_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);
-    }
-
-
-    protected function _delete_category($cat_id)
-    {
-        $cat_id = absint($cat_id);
-        wp_delete_term($cat_id, 'espresso_venue_categories');
-    }
-
-
-    /**
-     * @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',
-                'VEN_CAT_ID' => $cat_id,
-            ];
-        } else {
-            $query_args = ['action' => 'add_category'];
-        }
-        $this->_redirect_after_action($success, '', '', $query_args, true);
-    }
-
-
-    private function _insert_category($update = false)
-    {
-        $category_ID     = $update ? $this->request->getRequestParam('VEN_CAT_ID', '', 'int') : '';
-        $category_name   = $this->request->getRequestParam('category_name', '');
-        $category_desc   = $this->request->getRequestParam('category_desc', '', 'html');
-        $category_parent = $this->request->getRequestParam('category_parent', 0, 'int');
-
-        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,
-        ];
-
-        $insert_ids = $update
-            ? wp_update_term($category_ID, 'espresso_venue_categories', $term_args)
-            : wp_insert_term(
-                $category_name,
-                'espresso_venue_categories',
-                $term_args
-            );
-
-        if (! is_array($insert_ids)) {
-            EE_Error::add_error(
-                esc_html__('An error occurred and the category has not been saved to the database.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        } else {
-            $category_ID = $insert_ids['term_id'];
-            EE_Error::add_success(
-                sprintf(
-                    esc_html__('The category %s was successfully created', 'event_espresso'),
-                    $category_name
-                )
-            );
-        }
-
-        return $category_ID;
-    }
-
-
-    /**
-     * TODO handle category exports()
-     *
-     * @return void
-     */
-    protected function _categories_export()
-    {
-        // todo: I don't like doing this but it'll do until we modify EE_Export Class.
-        $this->request->mergeRequestParams(
-            [
-                'export'       => 'report',
-                'action'       => 'categories',
-                'category_ids' => $this->request->getRequestParam('VEN_CAT_ID', 0, 'int'),
-            ]
-        );
-
-        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();
-        }
-    }
-
-
-    protected function _import_categories()
-    {
-
-        require_once(EE_CLASSES . 'EE_Import.class.php');
-        EE_Import::instance()->import();
-    }
-
-
-    /**
-     * @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' => 'espresso_venue_categories'];
-        $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 */
-    /**************/
+	protected function _google_map_settings()
+	{
+
+
+		$this->_template_args['values']           = $this->_yes_no_values;
+		$default_map_settings                     = new stdClass();
+		$default_map_settings->use_google_maps    = true;
+		$default_map_settings->google_map_api_key = '';
+		// for event details pages (reg page)
+		$default_map_settings->event_details_map_width    = 585;
+		// ee_map_width_single
+		$default_map_settings->event_details_map_height   = 362;
+		// ee_map_height_single
+		$default_map_settings->event_details_map_zoom     = 14;
+		// ee_map_zoom_single
+		$default_map_settings->event_details_display_nav  = true;
+		// ee_map_nav_display_single
+		$default_map_settings->event_details_nav_size     = false;
+		// ee_map_nav_size_single
+		$default_map_settings->event_details_control_type = 'default';
+		// ee_map_type_control_single
+		$default_map_settings->event_details_map_align    = 'center';
+		// ee_map_align_single
+
+		// for event list pages
+		$default_map_settings->event_list_map_width    = 300;
+		// ee_map_width
+		$default_map_settings->event_list_map_height   = 185;
+		// ee_map_height
+		$default_map_settings->event_list_map_zoom     = 12;
+		// ee_map_zoom
+		$default_map_settings->event_list_display_nav  = false;
+		// ee_map_nav_display
+		$default_map_settings->event_list_nav_size     = true;
+		// ee_map_nav_size
+		$default_map_settings->event_list_control_type = 'dropdown';
+		// ee_map_type_control
+		$default_map_settings->event_list_map_align    = 'center';
+		// ee_map_align
+
+		$this->_template_args['map_settings'] =
+			isset(EE_Registry::instance()->CFG->map_settings)
+			&& ! empty(EE_Registry::instance()->CFG->map_settings)
+				? (object) array_merge(
+					(array) $default_map_settings,
+					(array) EE_Registry::instance()->CFG->map_settings
+				)
+				: $default_map_settings;
+
+		$this->_set_add_edit_form_tags('update_google_map_settings');
+		$this->_set_publish_post_box_vars(null, false, false, null, false);
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			EE_VENUES_TEMPLATE_PATH . 'google_map.template.php',
+			$this->_template_args,
+			true
+		);
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	protected function _update_google_map_settings()
+	{
+		$map_settings = EE_Registry::instance()->CFG->map_settings;
+
+		$settings = [
+			'use_google_maps'            => 'int',
+			'google_map_api_key'         => 'string',
+			'event_details_map_width'    => 'int',
+			'event_details_map_zoom'     => 'int',
+			'event_details_display_nav'  => 'int',
+			'event_details_nav_size'     => 'int',
+			'event_details_control_type' => 'string',
+			'event_details_map_align'    => 'string',
+			'event_list_map_width'       => 'int',
+			'event_list_map_height'      => 'int',
+			'event_list_map_zoom'        => 'int',
+			'event_list_display_nav'     => 'int',
+			'event_list_nav_size'        => 'int',
+			'event_list_control_type'    => 'string',
+			'event_list_map_align'       => 'string',
+		];
+
+		foreach ($settings as $setting => $type) {
+			$map_settings->{$setting} = $this->request->getRequestParam($setting, $map_settings->{$setting}, $type);
+		}
+
+		EE_Registry::instance()->CFG->map_settings = apply_filters(
+			'FHEE__Extend_General_Settings_Admin_Page___update_google_map_settings__CFG_map_settings',
+			$map_settings
+		);
+
+		$what    = 'Google Map Settings';
+		$success = $this->_update_espresso_configuration(
+			$what,
+			EE_Registry::instance()->CFG->map_settings,
+			__FILE__,
+			__FUNCTION__,
+			__LINE__
+		);
+		$this->_redirect_after_action($success, $what, 'updated', ['action' => 'google_map_settings']);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _venue_editor_metaboxes()
+	{
+		$this->verify_cpt_object();
+
+		add_meta_box(
+			'espresso_venue_address_options',
+			esc_html__('Physical Location', 'event_espresso'),
+			[$this, 'venue_address_metabox'],
+			$this->page_slug,
+			'side'
+		);
+		add_meta_box(
+			'espresso_venue_gmap_options',
+			esc_html__('Google Map', 'event_espresso'),
+			[$this, 'venue_gmap_metabox'],
+			$this->page_slug,
+			'side'
+		);
+		add_meta_box(
+			'espresso_venue_virtual_loc_options',
+			esc_html__('Virtual Location', 'event_espresso'),
+			[$this, 'venue_virtual_loc_metabox'],
+			$this->page_slug,
+			'side'
+		);
+	}
+
+
+	public function venue_gmap_metabox()
+	{
+		$template_args = [
+			'vnu_enable_for_gmap' => EEH_Form_Fields::select_input(
+				'vnu_enable_for_gmap',
+				$this->get_yes_no_values(),
+				$this->_cpt_model_obj instanceof EE_Venue ? $this->_cpt_model_obj->enable_for_gmap() : false
+			),
+			'vnu_google_map_link' => $this->_cpt_model_obj->google_map_link(),
+		];
+		$template      = EE_VENUES_TEMPLATE_PATH . 'venue_gmap_metabox_content.template.php';
+		EEH_Template::display_template($template, $template_args);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function venue_address_metabox()
+	{
+		$template_args['_venue'] = $this->_cpt_model_obj;
+
+		$template_args['states_dropdown']    = EEH_Form_Fields::generate_form_input(
+			new EE_Question_Form_Input(
+				EE_Question::new_instance(
+					['QST_display_text' => esc_html__('State', 'event_espresso'), 'QST_system' => 'state']
+				),
+				EE_Answer::new_instance(
+					[
+						'ANS_value' => $this->_cpt_model_obj instanceof EE_Venue
+							? $this->_cpt_model_obj->state_ID()
+							: 0,
+					]
+				),
+				[
+					'input_name'     => 'sta_id',
+					'input_id'       => 'sta_id',
+					'input_class'    => '',
+					'input_prefix'   => '',
+					'append_qstn_id' => false,
+				]
+			)
+		);
+		$template_args['countries_dropdown'] = EEH_Form_Fields::generate_form_input(
+			new EE_Question_Form_Input(
+				EE_Question::new_instance(
+					['QST_display_text' => esc_html__('Country', 'event_espresso'), 'QST_system' => 'country']
+				),
+				EE_Answer::new_instance(
+					[
+						'ANS_value' => $this->_cpt_model_obj instanceof EE_Venue
+							? $this->_cpt_model_obj->country_ID()
+							: 0,
+					]
+				),
+				[
+					'input_name'     => 'cnt_iso',
+					'input_id'       => 'cnt_iso',
+					'input_class'    => '',
+					'input_prefix'   => '',
+					'append_qstn_id' => false,
+				]
+			)
+		);
+
+		$template = EE_VENUES_TEMPLATE_PATH . 'venue_address_metabox_content.template.php';
+		EEH_Template::display_template($template, $template_args);
+	}
+
+
+	public function venue_virtual_loc_metabox()
+	{
+		$template_args = [
+			'_venue' => $this->_cpt_model_obj,
+		];
+		$template      = EE_VENUES_TEMPLATE_PATH . 'venue_virtual_location_metabox_content.template.php';
+		EEH_Template::display_template($template, $template_args);
+	}
+
+
+	protected function _restore_cpt_item($post_id, $revision_id)
+	{
+		$venue_obj = $this->_venue_model->get_one_by_ID($post_id);
+
+		// meta revision restore
+		$venue_obj->restore_revision($revision_id);
+	}
+
+
+	/**
+	 * Handles updates for venue cpts
+	 *
+	 * @param int    $post_id ID of Venue CPT
+	 * @param WP_Post $post    Post object (with "blessed" WP properties)
+	 * @return void
+	 */
+	protected function _insert_update_cpt_item($post_id, $post)
+	{
+
+		if ($post instanceof WP_Post && $post->post_type !== 'espresso_venues') {
+			return;// get out we're not processing the saving of venues.
+		}
+
+		$wheres = [$this->_venue_model->primary_key_name() => $post_id];
+
+		$venue_values = [
+			'VNU_address'         => $this->request->getRequestParam('vnu_address'),
+			'VNU_address2'        => $this->request->getRequestParam('vnu_address2'),
+			'VNU_city'            => $this->request->getRequestParam('vnu_city'),
+			'STA_ID'              => $this->request->getRequestParam('sta_id'),
+			'CNT_ISO'             => $this->request->getRequestParam('cnt_iso'),
+			'VNU_zip'             => $this->request->getRequestParam('vnu_zip'),
+			'VNU_phone'           => $this->request->getRequestParam('vnu_phone'),
+			'VNU_capacity'        => $this->request->requestParamIsSet('vnu_capacity')
+				? str_replace(',', '', $this->request->getRequestParam('vnu_capacity'))
+				: EE_INF,
+			'VNU_url'             => $this->request->getRequestParam('vnu_url'),
+			'VNU_virtual_phone'   => $this->request->getRequestParam('vnu_virtual_phone'),
+			'VNU_virtual_url'     => $this->request->getRequestParam('vnu_virtual_url'),
+			'VNU_enable_for_gmap' => $this->request->getRequestParam('vnu_enable_for_gmap', false, 'bool'),
+			'VNU_google_map_link' => $this->request->getRequestParam('vnu_google_map_link'),
+		];
+
+		// update venue
+		$success = $this->_venue_model->update($venue_values, [$wheres]);
+
+		// get venue_object for other metaboxes that might be added via the filter... though it would seem to make sense to just use $this->_venue_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!
+		$get_one_where = [$this->_venue_model->primary_key_name() => $post_id, 'status' => $post->post_status];
+		$venue         = $this->_venue_model->get_one([$get_one_where]);
+
+		// notice we've applied a filter for venue metabox callbacks but we don't actually have any default venue metaboxes in use.  So this is just here for addons to more easily hook into venue saves.
+		$venue_update_callbacks = apply_filters(
+			'FHEE__Venues_Admin_Page___insert_update_cpt_item__venue_update_callbacks',
+			[]
+		);
+		$att_success            = true;
+		foreach ($venue_update_callbacks as $v_callback) {
+			// if ANY of these updates fail then we want the appropriate global error message
+			$att_success = call_user_func_array($v_callback, [$venue, $this->request->requestParams()])
+				? $att_success
+				: false;
+		}
+
+		// any errors?
+		if ($success && ! $att_success) {
+			EE_Error::add_error(
+				esc_html__(
+					'Venue Details saved successfully but something went wrong with saving attachments.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		} elseif ($success === false) {
+			EE_Error::add_error(
+				esc_html__('Venue Details did not save successfully.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+	}
+
+
+	/**
+	 * @param int $post_id
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function trash_cpt_item($post_id)
+	{
+		$this->request->setRequestParam('VNU_ID', $post_id);
+		$this->_trash_or_restore_venue('trash', false);
+	}
+
+
+	/**
+	 * @param int $post_id
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function restore_cpt_item($post_id)
+	{
+		$this->request->setRequestParam('VNU_ID', $post_id);
+		$this->_trash_or_restore_venue('draft', false);
+	}
+
+
+	/**
+	 * @param int $post_id
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function delete_cpt_item($post_id)
+	{
+		$this->request->setRequestParam('VNU_ID', $post_id);
+		$this->_delete_venue(false);
+	}
+
+
+	public function get_venue_object()
+	{
+		return $this->_cpt_model_obj;
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _trash_or_restore_venue($venue_status = 'trash', $redirect_after = true)
+	{
+		$VNU_ID = $this->request->getRequestParam('VNU_ID', 0, 'int');
+
+		// loop thru venues
+		if ($VNU_ID) {
+			// clean status
+			$venue_status = sanitize_key($venue_status);
+			// grab status
+			if (! empty($venue_status)) {
+				$success = $this->_change_venue_status($VNU_ID, $venue_status);
+			} else {
+				$success = false;
+				$msg     = esc_html__(
+					'An error occurred. The venue could not be moved to the trash because a valid venue 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 venue could not be moved to the trash because a valid venue ID was not not supplied.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+		$action = $venue_status == 'trash' ? 'moved to the trash' : 'restored from the trash';
+
+		if ($redirect_after) {
+			$this->_redirect_after_action($success, 'Venue', $action, ['action' => 'default']);
+		}
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _trash_or_restore_venues($venue_status = 'trash')
+	{
+		// clean status
+		$venue_status = sanitize_key($venue_status);
+		// grab status
+		if (! empty($venue_status)) {
+			$success = true;
+			// determine the event id and set to array.
+			$VNU_IDs = $this->request->getRequestParam('venue_id', [], 'int', true);
+			// loop thru events
+			foreach ($VNU_IDs as $VNU_ID) {
+				if ($VNU_ID = absint($VNU_ID)) {
+					$results = $this->_change_venue_status($VNU_ID, $venue_status);
+					$success = $results !== false ? $success : false;
+				} else {
+					$msg = sprintf(
+						esc_html__(
+							'An error occurred. Venue #%d could not be moved to the trash because a valid venue ID was not not supplied.',
+							'event_espresso'
+						),
+						$VNU_ID
+					);
+					EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+					$success = false;
+				}
+			}
+		} else {
+			$success = false;
+			$msg     = esc_html__(
+				'An error occurred. The venue could not be moved to the trash because a valid venue 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  = $venue_status == 'trash' ? 'moved to the trash' : 'restored from the trash';
+		$this->_redirect_after_action($success, 'Venues', $action, ['action' => 'default']);
+	}
+
+
+	/**
+	 * _trash_or_restore_venues
+	 *
+	 * //todo this is pretty much the same as the corresponding change_event_status method in Events_Admin_Page.  We
+	 * should probably abstract this up to the EE_Admin_Page_CPT (or even EE_Admin_Page) and make this a common method
+	 * accepting a certain number of params.
+	 *
+	 * @access  private
+	 * @param int    $VNU_ID
+	 * @param string $venue_status
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _change_venue_status($VNU_ID = 0, $venue_status = '')
+	{
+		// grab venue id
+		if (! $VNU_ID) {
+			$msg = esc_html__('An error occurred. No Venue ID or an invalid Venue ID was received.', 'event_espresso');
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+
+		$this->_cpt_model_obj = EEM_Venue::instance()->get_one_by_ID($VNU_ID);
+
+		// clean status
+		$venue_status = sanitize_key($venue_status);
+		// grab status
+		if (! $venue_status) {
+			$msg = esc_html__(
+				'An error occurred. No Venue Status or an invalid Venue Status was received.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+
+		// was event trashed or restored ?
+		switch ($venue_status) {
+			case 'draft':
+				$action = 'restored from the trash';
+				$hook   = 'AHEE_venue_restored_from_trash';
+				break;
+			case 'trash':
+				$action = 'moved to the trash';
+				$hook   = 'AHEE_venue_moved_to_trash';
+				break;
+			default:
+				$action = 'updated';
+				$hook   = false;
+		}
+		// use class to change status
+		$this->_cpt_model_obj->set_status($venue_status);
+		$success = $this->_cpt_model_obj->save();
+
+		if ($success === false) {
+			$msg = sprintf(esc_html__('An error occurred. The venue 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 bool $redirect_after
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _delete_venue($redirect_after = true)
+	{
+		// determine the venue id and set to array.
+		$VNU_ID = $this->request->getRequestParam('VNU_ID', 0, 'int');
+		$VNU_ID = $this->request->getRequestParam('post', $VNU_ID, 'int');
+
+		// loop thru venues
+		if ($VNU_ID) {
+			$success = $this->_delete_or_trash_venue($VNU_ID);
+		} else {
+			$success = false;
+			$msg     = esc_html__(
+				'An error occurred. An venue could not be deleted because a valid venue ID was not not supplied.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+		if ($redirect_after) {
+			$this->_redirect_after_action($success, 'Venue', 'deleted', ['action' => 'default']);
+		}
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _delete_venues()
+	{
+		$success = true;
+		// determine the event id and set to array.
+		$VNU_IDs = $this->request->getRequestParam('venue_id', [], 'int', true);
+		// loop thru events
+		foreach ($VNU_IDs as $VNU_ID) {
+			if ($VNU_ID = absint($VNU_ID)) {
+				$results = $this->_delete_or_trash_venue($VNU_ID);
+				$success = $results !== false ? $success : false;
+			} else {
+				$success = false;
+				$msg     = esc_html__(
+					'An error occurred. An venue could not be deleted because a valid venue ID 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;
+		$this->_redirect_after_action(
+			$success,
+			esc_html__('Venues', 'event_espresso'),
+			esc_html__('deleted', 'event_espresso'),
+			['action' => 'default']
+		);
+	}
+
+
+	// todo: put in parent
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _delete_or_trash_venue($VNU_ID = false)
+	{
+		// grab event id
+		if (! $VNU_ID = absint($VNU_ID)) {
+			$msg = esc_html__('An error occurred. No Venue ID or an invalid Venue ID was received.', 'event_espresso');
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+
+
+		$venue = EEM_Venue::instance()->get_one_by_ID($VNU_ID);
+		// first need to remove all term relationships
+		$venue->_remove_relations('Term_Taxonomy');
+		$success = $venue->delete_permanently();
+		// did it all go as planned ?
+		if ($success) {
+			$msg = sprintf(esc_html__('Venue ID # %d has been deleted.', 'event_espresso'), $VNU_ID);
+			EE_Error::add_success($msg);
+		} else {
+			$msg =
+				sprintf(
+					esc_html__('An error occurred. Venue ID # %d could not be deleted.', 'event_espresso'),
+					$VNU_ID
+				);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		do_action('AHEE__Venues_Admin_Page___delete_or_trash_venue__after_venue_deleted');
+		return true;
+	}
+
+
+
+
+	/***********/
+	/* QUERIES */
+
+
+	public function get_venues($per_page = 10, $count = false)
+	{
+
+		$orderby = $this->request->getRequestParam('orderby', '');
+
+		switch ($orderby) {
+			case 'id':
+				$orderby = 'VNU_ID';
+				break;
+
+			case 'capacity':
+				$orderby = 'VNU_capacity';
+				break;
+
+			case 'city':
+				$orderby = 'VNU_city';
+				break;
+
+			default:
+				$orderby = 'VNU_name';
+		}
+
+		$sort         = $this->request->getRequestParam('order', 'ASC');
+		$current_page = $this->request->getRequestParam('paged', 1, 'int');
+		$per_page     = ! empty($per_page) ? $per_page : 10;
+		$per_page     = $this->request->getRequestParam('perpage', $per_page, 'int');
+
+		$offset = ($current_page - 1) * $per_page;
+		$limit  = [$offset, $per_page];
+
+		$category = $this->request->getRequestParam('category');
+		$category = $category > 0 ? $category : null;
+
+		$where = [];
+
+		// only set initial status if it is in the incoming request.  Otherwise the "all" view display's all statuses.
+		$status = $this->request->getRequestParam('status');
+		if ($status && $status !== 'all') {
+			$where['status'] = $status;
+		}
+
+		$venue_status = $this->request->getRequestParam('venue_status');
+		if ($venue_status) {
+			$where['status'] = $venue_status;
+		}
+
+
+		if ($category) {
+			$where['Term_Taxonomy.taxonomy'] = 'espresso_venue_categories';
+			$where['Term_Taxonomy.term_id']  = $category;
+		}
+
+
+		if (! EE_Registry::instance()->CAP->current_user_can('ee_read_others_venues', 'get_venues')) {
+			$where['VNU_wp_user'] = get_current_user_id();
+		} else {
+			if (! EE_Registry::instance()->CAP->current_user_can('ee_read_private_venues', 'get_venues')) {
+				$where['OR'] = [
+					'status*restrict_private' => ['!=', 'private'],
+					'AND'                     => [
+						'status*inclusive' => ['=', 'private'],
+						'VNU_wp_user'      => get_current_user_id(),
+					],
+				];
+			}
+		}
+
+		$search_term = $this->request->getRequestParam('s');
+		if ($search_term) {
+			$search_term = '%' . $search_term . '%';
+			$where['OR'] = [
+				'VNU_name'               => ['LIKE', $search_term],
+				'VNU_desc'               => ['LIKE', $search_term],
+				'VNU_short_desc'         => ['LIKE', $search_term],
+				'VNU_address'            => ['LIKE', $search_term],
+				'VNU_address2'           => ['LIKE', $search_term],
+				'VNU_city'               => ['LIKE', $search_term],
+				'VNU_zip'                => ['LIKE', $search_term],
+				'VNU_phone'              => ['LIKE', $search_term],
+				'VNU_url'                => ['LIKE', $search_term],
+				'VNU_virtual_phone'      => ['LIKE', $search_term],
+				'VNU_virtual_url'        => ['LIKE', $search_term],
+				'VNU_google_map_link'    => ['LIKE', $search_term],
+				'Event.EVT_name'         => ['LIKE', $search_term],
+				'Event.EVT_desc'         => ['LIKE', $search_term],
+				'Event.EVT_phone'        => ['LIKE', $search_term],
+				'Event.EVT_external_URL' => ['LIKE', $search_term],
+			];
+		}
+
+
+		return $count
+			? $this->_venue_model->count([$where], 'VNU_ID')
+			: $this->_venue_model->get_all(
+				[$where, 'limit' => $limit, 'order_by' => $orderby, 'order' => $sort]
+			);
+	}
+
+
+
+
+	/** Venue 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('VEN_CAT_ID', 0, 'int');
+		if (! $category_ID) {
+			return;
+		}
+
+		$term = get_term($category_ID, 'espresso_venue_categories');
+
+
+		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;
+		}
+	}
+
+
+	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 EE_Error
+	 */
+	protected function _category_list_table()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
+			'add_category',
+			'add_category',
+			[],
+			'add-new-h2'
+		);
+		$this->_search_btn_label = esc_html__('Venue Categories', 'event_espresso');
+		$this->display_admin_list_table_page_with_sidebar();
+	}
+
+
+	/**
+	 * @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';
+
+		$redirect = EE_Admin_Page::add_query_args_and_nonce(['action' => 'category_list'], $this->_admin_base_url);
+
+		$this->_set_publish_post_box_vars('VEN_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();
+	}
+
+
+	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(
+			['espresso_venue_categories'],
+			['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);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	protected function _delete_categories()
+	{
+		$category_ID  = $this->request->getRequestParam('category_id', 0, 'int');
+		$category_IDs = $this->request->getRequestParam('VEN_CAT_ID', [$category_ID], 'int', true);
+
+		foreach ($category_IDs as $cat_id) {
+			$this->_delete_category($cat_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);
+	}
+
+
+	protected function _delete_category($cat_id)
+	{
+		$cat_id = absint($cat_id);
+		wp_delete_term($cat_id, 'espresso_venue_categories');
+	}
+
+
+	/**
+	 * @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',
+				'VEN_CAT_ID' => $cat_id,
+			];
+		} else {
+			$query_args = ['action' => 'add_category'];
+		}
+		$this->_redirect_after_action($success, '', '', $query_args, true);
+	}
+
+
+	private function _insert_category($update = false)
+	{
+		$category_ID     = $update ? $this->request->getRequestParam('VEN_CAT_ID', '', 'int') : '';
+		$category_name   = $this->request->getRequestParam('category_name', '');
+		$category_desc   = $this->request->getRequestParam('category_desc', '', 'html');
+		$category_parent = $this->request->getRequestParam('category_parent', 0, 'int');
+
+		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,
+		];
+
+		$insert_ids = $update
+			? wp_update_term($category_ID, 'espresso_venue_categories', $term_args)
+			: wp_insert_term(
+				$category_name,
+				'espresso_venue_categories',
+				$term_args
+			);
+
+		if (! is_array($insert_ids)) {
+			EE_Error::add_error(
+				esc_html__('An error occurred and the category has not been saved to the database.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		} else {
+			$category_ID = $insert_ids['term_id'];
+			EE_Error::add_success(
+				sprintf(
+					esc_html__('The category %s was successfully created', 'event_espresso'),
+					$category_name
+				)
+			);
+		}
+
+		return $category_ID;
+	}
+
+
+	/**
+	 * TODO handle category exports()
+	 *
+	 * @return void
+	 */
+	protected function _categories_export()
+	{
+		// todo: I don't like doing this but it'll do until we modify EE_Export Class.
+		$this->request->mergeRequestParams(
+			[
+				'export'       => 'report',
+				'action'       => 'categories',
+				'category_ids' => $this->request->getRequestParam('VEN_CAT_ID', 0, 'int'),
+			]
+		);
+
+		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();
+		}
+	}
+
+
+	protected function _import_categories()
+	{
+
+		require_once(EE_CLASSES . 'EE_Import.class.php');
+		EE_Import::instance()->import();
+	}
+
+
+	/**
+	 * @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' => 'espresso_venue_categories'];
+		$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 */
+	/**************/
 }

admin_pages/events/templates/event_tickets_metabox_ticket_row.template.php

Braces +10 added lines, -4 removed lines

@@ -84,12 +84,15 @@ 
                    name="edit_prices[<?php echo esc_attr($ticketrow); ?>][1][PRC_amount]"
                    value="<?php echo esc_attr($PRC_amount); ?>"
             />
-        <?php else : ?>
+        <?php else {
+	: ?>
             <input type="text"
                    size="1"
                    class="edit-price-PRC_amount ee-small-text-inp ee-inp-right"
                    name="disabled_price_amount"
-                   value="<?php echo esc_attr($PRC_amount); ?>"
+                   value="<?php echo esc_attr($PRC_amount);
+}
+?>"
                 <?php echo esc_attr($disabled); ?>
             />
             <input type="hidden"
@@ -123,11 +126,14 @@ 
                    name="<?php echo esc_attr("{$edit_ticketrow_name}[{$ticketrow}][TKT_qty]"); ?>"
                    value="<?php echo absint($TKT_qty); ?>"
             />
-        <?php else : ?>
+        <?php else {
+	: ?>
             <input type="text"
                    class="edit-ticket-TKT_qty ee-small-text-inp ee-inp-right"
                    name="disabled_tkt_qty"
-                   value="<?php echo absint($TKT_qty); ?>"
+                   value="<?php echo absint($TKT_qty);
+}
+?>"
                 <?php echo esc_attr($disabled); ?>
             />
             <input type="hidden"

core/admin/EE_Admin_Page_CPT.core.php

Indentation +1470 added lines, -1470 removed lines

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

modules/gateways/Invoice/lib/templates/receipt_body.template.php

Indentation +114 added lines, -114 removed lines

@@ -61,16 +61,16 @@ 
             <h3 class="section-title event-name">
                 <img class="icon" src="<?php echo EE_IMAGES_URL . 'calendar_year-24x24.png'; ?>">
                 <?php
-                esc_html_e(
-                    "Event Name:",
-                    "event_espresso"
-                ) ?>
+				esc_html_e(
+					"Event Name:",
+					"event_espresso"
+				) ?>
                 <span class="plain-text"><?php echo $event->name(); ?></span>
                 <span class="small-text link">
                 [ <a href='<?php echo esc_url_raw($event->get_permalink()) ?>'><?php esc_html_e(
-                    'view',
-                    'event_espresso'
-                ); ?></a> ]
+					'view',
+					'event_espresso'
+				); ?></a> ]
             </span>
             </h3>
             <?php if (strlen($event->description() > 1)) { ?>
@@ -78,14 +78,14 @@ 
             <?php } ?>
             <ul class="tickets-per-event">
                 <?php
-                foreach ($ticket_line_items_per_event[ $event_id ] as $line_item_id => $line_item) {
-                    $ticket       = $line_item->ticket();
-                    $taxable_html = $ticket->taxable()
-                        ? '*'
-                        : '';
-                    $subitems     = $line_item->children();
-                    $ticket_uses  = $ticket->get_pretty('TKT_uses', esc_html__("any", "event_espresso"));
-                    ?>
+				foreach ($ticket_line_items_per_event[ $event_id ] as $line_item_id => $line_item) {
+					$ticket       = $line_item->ticket();
+					$taxable_html = $ticket->taxable()
+						? '*'
+						: '';
+					$subitems     = $line_item->children();
+					$ticket_uses  = $ticket->get_pretty('TKT_uses', esc_html__("any", "event_espresso"));
+					?>
                     <li class="event-ticket">
                         <div class="ticket-details">
                             <table class="invoice-amount">
@@ -94,7 +94,7 @@ 
                                         <th class="name-column"><?php esc_html_e("Ticket", "event_espresso"); ?></th>
                                         <th colspan="2" class="desc-column">
                                             <?php
-                                            esc_html_e("Description", 'event_espresso'); ?>
+											esc_html_e("Description", 'event_espresso'); ?>
                                         </th>
                                         <th class="number-column item_r">
                                             <?php esc_html_e("Quantity", "event_espresso"); ?>
@@ -109,20 +109,20 @@ 
                                 </thead>
                                 <tbody>
                                     <?php
-                                    if (count($subitems) < 2) { ?>
+									if (count($subitems) < 2) { ?>
                                         <tr class="item">
                                             <td><?php echo esc_html($line_item->name() . $taxable_html); ?></td>
                                             <td colspan="2">
                                                 <?php echo esc_html($line_item->desc()); ?>
                                                 <p class="ticket-note">
                                                     <?php
-                                                    echo sprintf(
-                                                        esc_html__(
-                                                            'This ticket can be used once at %s of the dates/times below.',
-                                                            'event_espresso'
-                                                        ),
-                                                        $ticket_uses
-                                                    ); ?>
+													echo sprintf(
+														esc_html__(
+															'This ticket can be used once at %s of the dates/times below.',
+															'event_espresso'
+														),
+														$ticket_uses
+													); ?>
                                                 </p>
                                             </td>
                                             <td class="item_r">
@@ -136,7 +136,7 @@ 
                                             </td>
                                         </tr>
                                         <?php
-                                    } else { ?>
+									} else { ?>
                                         <tr class="item">
                                             <td class="aln-left">
                                                 <?php echo esc_html($line_item->name() . $taxable_html); ?>
@@ -145,13 +145,13 @@ 
                                                 <?php echo esc_html($line_item->desc()); ?>
                                                 <p class="ticket-note">
                                                     <?php
-                                                    echo sprintf(
-                                                        esc_html__(
-                                                            'This ticket can be used once at %s of the dates/times below.',
-                                                            'event_espresso'
-                                                        ),
-                                                        $ticket_uses
-                                                    ); ?>
+													echo sprintf(
+														esc_html__(
+															'This ticket can be used once at %s of the dates/times below.',
+															'event_espresso'
+														),
+														$ticket_uses
+													); ?>
                                                 </p>
                                             </td>
                                             <td class="item_c">
@@ -165,8 +165,8 @@ 
                                             </td>
                                         </tr>
                                         <?php
-                                        foreach ($subitems as $sub_line_item) {
-                                            $is_percent = $sub_line_item->is_percent(); ?>
+										foreach ($subitems as $sub_line_item) {
+											$is_percent = $sub_line_item->is_percent(); ?>
                                             <tr class="subitem-row">
                                                 <td class="subitem">
                                                     <?php echo esc_html($sub_line_item->name()); ?>
@@ -178,14 +178,14 @@ 
                                                     <?php // echo $is_percent ? '' : $sub_line_item->quantity()?>
                                                 </td>
                                                 <td class="item_c"><?php
-                                                    echo $is_percent
-                                                        ? $sub_line_item->percent() . "%"
-                                                        : $sub_line_item->unit_price_no_code(); // already escaped ?>
+													echo $is_percent
+														? $sub_line_item->percent() . "%"
+														: $sub_line_item->unit_price_no_code(); // already escaped ?>
                                                 </td>
                                                 <td class="item_r"><?php echo $sub_line_item->total_no_code() ?></td>
                                             </tr>
                                             <?php
-                                        } ?>
+										} ?>
                                         <tr class="total_tr odd">
                                             <td colspan="4"></td>
                                             <td class="total" nowrap="nowrap">
@@ -196,7 +196,7 @@ 
                                             </td>
                                         </tr>
                                         <?php
-                                    } ?>
+									} ?>
                                 </tbody>
                             </table>
 
@@ -209,50 +209,50 @@ 
                                              src="<?php echo esc_url_raw(EE_IMAGES_URL . 'clock-16x16.png'); ?>"
                                         >
                                         <?php
-                                        echo _n(
-                                            "Date/Time:",
-                                            "Dates/Times:",
-                                            count($ticket->datetimes()),
-                                            'event_espresso'
-                                        ); ?></h4>
+										echo _n(
+											"Date/Time:",
+											"Dates/Times:",
+											count($ticket->datetimes()),
+											'event_espresso'
+										); ?></h4>
                                     <ul class="event-dates">
                                         <?php
-                                        foreach ($ticket->datetimes_ordered() as $datetime) {
-                                            /* @var $datetime EE_Datetime */ ?>
+										foreach ($ticket->datetimes_ordered() as $datetime) {
+											/* @var $datetime EE_Datetime */ ?>
                                             <li><?php
-                                                echo $datetime->name()
-                                                    ? '<b>' . esc_html($datetime->name()) . ' </b>'
-                                                    : '';
-                                                echo sprintf(
-                                                    esc_html__("%s - %s (%s)", "event_espresso"),
-                                                    $datetime->start_date_and_time(),
-                                                    $datetime->end_date_and_time(),
-                                                    $datetime->get_timezone()
-                                                );
-                                                echo $datetime->description()
-                                                    ? '<p class="ticket-note">' . $datetime->description() . '</p>'
-                                                    : '' ?></li>
+												echo $datetime->name()
+													? '<b>' . esc_html($datetime->name()) . ' </b>'
+													: '';
+												echo sprintf(
+													esc_html__("%s - %s (%s)", "event_espresso"),
+													$datetime->start_date_and_time(),
+													$datetime->end_date_and_time(),
+													$datetime->get_timezone()
+												);
+												echo $datetime->description()
+													? '<p class="ticket-note">' . $datetime->description() . '</p>'
+													: '' ?></li>
                                             <?php
-                                        } ?>
+										} ?>
                                     </ul>
                                 </div>
                                 <?php
-                                if ($event->venues()) { ?>
+								if ($event->venues()) { ?>
                                     <div class="ticket-place-details">
                                         <h4 class="sub-section-title no-bottom-margin">
                                             <img class="icon" src="<?php
-                                            echo esc_url_raw(EE_IMAGES_URL . 'location-pin-16x16.png'); ?>"
+											echo esc_url_raw(EE_IMAGES_URL . 'location-pin-16x16.png'); ?>"
                                             >
                                             <?php
-                                            echo _n(
-                                                "Venue:",
-                                                "Venues:",
-                                                count($event->venues()),
-                                                'event_espresso'
-                                            ); ?></h4>
+											echo _n(
+												"Venue:",
+												"Venues:",
+												count($event->venues()),
+												'event_espresso'
+											); ?></h4>
                                         <ul class="event-venues">
                                             <?php
-                                            foreach ($event->venues() as $venue) { ?>
+											foreach ($event->venues() as $venue) { ?>
                                                 <li>
                                                     <?php echo esc_html($venue->name()) ?>
                                                     <span class="small-text">
@@ -267,15 +267,15 @@ 
                                         </ul>
                                     </div>
                                     <?php
-                                } ?>
+								} ?>
                             </div>
                             <div class="ticket-registrations-area">
                                 <h4 class="sub-section-title">
                                     <img class="icon" src="<?php
-                                    echo esc_url_raw(EE_IMAGES_URL . 'users-16x16.png'); ?>"
+									echo esc_url_raw(EE_IMAGES_URL . 'users-16x16.png'); ?>"
                                     >
                                     <?php
-                                    echo esc_html__("Registration Details", "event_espresso"); ?>
+									echo esc_html__("Registration Details", "event_espresso"); ?>
                                     <span class="small-text link">[
                                 <a class="print_button noPrint" href="<?php echo esc_url_raw($edit_reg_info_url); ?>">
                                     <?php esc_html_e('edit', 'event_espresso'); ?>
@@ -285,12 +285,12 @@ 
                                 </h4>
                                 <ul class="ticket-registrations-list">
                                     <?php
-                                    foreach ($registrations_per_line_item[ $line_item_id ] as $registration) {
-                                        /* @var $registration EE_Registration */
-                                        $attendee = $registration->attendee();
-                                        $answers  = $registration->answers(
-                                            ['order_by' => ['Question.Question_Group_Question.QGQ_order' => 'ASC']]
-                                        ); ?>
+									foreach ($registrations_per_line_item[ $line_item_id ] as $registration) {
+										/* @var $registration EE_Registration */
+										$attendee = $registration->attendee();
+										$answers  = $registration->answers(
+											['order_by' => ['Question.Question_Group_Question.QGQ_order' => 'ASC']]
+										); ?>
                                         <li class="ticket-registration">
                                             <table class="registration-details">
                                                 <tr class="odd">
@@ -305,7 +305,7 @@ 
                                                     </td>
                                                 </tr>
                                                 <?php
-                                                foreach ($event->question_groups() as $question_group) { ?>
+												foreach ($event->question_groups() as $question_group) { ?>
                                                     <tr>
                                                         <th>
                                                             <?php $question_group->e('QSG_name'); ?>
@@ -313,44 +313,44 @@ 
                                                         <td></td>
                                                     </tr>
                                                     <?php $has_personal_info = false;
-                                                    foreach ($question_group->questions() as $question) {
-                                                        if (in_array($question->system_ID(), $questions_to_skip)) {
-                                                            $has_personal_info = true;
-                                                            continue;
-                                                        }
-                                                        ?>
+													foreach ($question_group->questions() as $question) {
+														if (in_array($question->system_ID(), $questions_to_skip)) {
+															$has_personal_info = true;
+															continue;
+														}
+														?>
                                                         <tr>
                                                             <th>
                                                                 <?php echo $question->display_text(
-                                                                ); // already escaped ?>
+																); // already escaped ?>
                                                             </th>
                                                             <td>
                                                                 <?php echo $registration->answer_value_to_question(
-                                                                    $question
-                                                                ); // already escaped?>
+																	$question
+																); // already escaped?>
                                                             </td>
                                                         </tr>
                                                     <?php }
-                                                    if ($has_personal_info) { ?>
+													if ($has_personal_info) { ?>
                                                         <tr>
                                                             <th><?php esc_html_e('Attendee', 'event_espresso'); ?></th>
                                                             <td>
                                                                 <?php
-                                                                echo sprintf(
-                                                                    esc_html__('%s (%s)', "event_espresso"),
-                                                                    esc_html($attendee->full_name()),
-                                                                    sanitize_email($attendee->email())
-                                                                ) ?>
+																echo sprintf(
+																	esc_html__('%s (%s)', "event_espresso"),
+																	esc_html($attendee->full_name()),
+																	sanitize_email($attendee->email())
+																) ?>
                                                             </td>
                                                         </tr>
                                                         <?php
-                                                    }
-                                                }
-                                                ?>
+													}
+												}
+												?>
                                             </table>
                                         </li>
                                         <?php
-                                    } ?>
+									} ?>
                                 </ul>
                             </div>
                         </div>
@@ -394,10 +394,10 @@ 
     <div class="grand-total-dv">
         <h2 class="grand-total">
             <?php
-            printf(
-                esc_html__("Grand Total: %s", "event_espresso"),
-                EEH_Template::format_currency($total_cost)
-            ); ?>
+			printf(
+				esc_html__("Grand Total: %s", "event_espresso"),
+				EEH_Template::format_currency($total_cost)
+			); ?>
         </h2>
     </div>
     <div class="payment-dv">
@@ -416,13 +416,13 @@ 
             </thead>
             <tbody>
                 <?php
-                $c = false;
-                if (! empty($payments)) {
-                    foreach ($payments as $payment) {
-                        /* @var $payment EE_Payment */ ?>
+				$c = false;
+				if (! empty($payments)) {
+					foreach ($payments as $payment) {
+						/* @var $payment EE_Payment */ ?>
                         <tr class='item <?php echo(($c = ! $c)
-                            ? ' odd'
-                            : '') ?>'
+							? ' odd'
+							: '') ?>'
                         >
                             <td><?php $payment->e('PAY_gateway') ?></td>
                             <td><?php echo esc_html($payment->timestamp()); ?></td>
@@ -432,14 +432,14 @@ 
                             <td class='item_r'><?php echo $payment->amount_no_code(); // already escaped ?></td>
                         </tr>
                     <?php }
-                } else { ?>
+				} else { ?>
                     <tr class='item'>
                         <td class='aln-cntr' colspan="6">
                             <?php
-                            esc_html_e(
-                                "No approved payments have been received.",
-                                'event_espresso'
-                            ) ?>
+							esc_html_e(
+								"No approved payments have been received.",
+								'event_espresso'
+							) ?>
                         </td>
                     </tr>
                 <?php } ?>
@@ -476,7 +476,7 @@ 
             <?php if ($venues_for_events) { ?>
                 <h2>
                     <?php
-                    echo _n("Venue Details:", "Venues Details:", count($venues_for_events), "event_espresso"); ?>
+					echo _n("Venue Details:", "Venues Details:", count($venues_for_events), "event_espresso"); ?>
                 </h2>
                 <table class="venue-list">
                     <?php foreach ($venues_for_events as $venue) { ?>

caffeinated/admin/new/pricing/templates/event_tickets_metabox_main.template.php

Indentation +6 added lines, -6 removed lines

@@ -73,7 +73,7 @@ 
             </thead>
             <tbody class="datetime-editing-dtts-tbody">
             <?php
-            echo $datetime_rows; ?>
+			echo $datetime_rows; ?>
             </tbody>
         </table>
         <div style="clear:both"></div>
@@ -139,10 +139,10 @@ 
     <div style="clear:both"></div>
 
     <?php
-    if (isset($status_change_notice)) {
-        echo $status_change_notice;
-    }
-    ?>
+	if (isset($status_change_notice)) {
+		echo $status_change_notice;
+	}
+	?>
 
     <div class="available-tickets-container">
         <h3 class="event-tickets-datetimes-title">
@@ -194,7 +194,7 @@ 
                 </thead>
                 <tbody>
                 <?php
-                echo $ticket_rows; ?>
+				echo $ticket_rows; ?>
                 </tbody>
             </table> <!-- end .ticket-table -->