@@ -7,13 +7,13 @@ discard block |
||
7 | 7 | class Yikes_Inc_Easy_Mailchimp_Extender_Helper { |
8 | 8 | |
9 | 9 | /** |
10 | - * Helper functions to help out with extensions (still fleshing out) |
|
11 | - * @since 6.0 |
|
12 | - * @ Parameters (array of data) |
|
13 | - * - Section ID - id of the section, should be a slug style text ie: 'custom-section' |
|
14 | - * - Link Text - Visible text for this link ie: 'Custom Section' |
|
15 | - * - Dashicon - class of the icon you would like to use for this link |
|
16 | - **/ |
|
10 | + * Helper functions to help out with extensions (still fleshing out) |
|
11 | + * @since 6.0 |
|
12 | + * @ Parameters (array of data) |
|
13 | + * - Section ID - id of the section, should be a slug style text ie: 'custom-section' |
|
14 | + * - Link Text - Visible text for this link ie: 'Custom Section' |
|
15 | + * - Dashicon - class of the icon you would like to use for this link |
|
16 | + **/ |
|
17 | 17 | public static function add_edit_form_section_link( $link_array=array() ) { |
18 | 18 | if( !empty( $link_array ) ) { |
19 | 19 | $link_data = wp_parse_args( array() , $link_array ); |
@@ -36,17 +36,17 @@ discard block |
||
36 | 36 | } |
37 | 37 | |
38 | 38 | /** |
39 | - * Helper functions to help out with extensions (still fleshing out) |
|
40 | - * @since 6.0 |
|
41 | - * @ Parameters: |
|
42 | - * - Section ID - id of the section, should be a slug style text ie: 'custom-section' |
|
43 | - * - Class - class file to call function from? |
|
44 | - * - Main Callback - call back for main section |
|
45 | - * - Main Section Title - main section title |
|
46 | - * - Sidebar Callback - callback for the sidebar section |
|
47 | - * - Sidebar Title - title of the sidebar section |
|
48 | - * - Class - class to reference funtions out of (optiona, if left blank functions should be defined in functions.php (or outside of a class)) |
|
49 | - **/ |
|
39 | + * Helper functions to help out with extensions (still fleshing out) |
|
40 | + * @since 6.0 |
|
41 | + * @ Parameters: |
|
42 | + * - Section ID - id of the section, should be a slug style text ie: 'custom-section' |
|
43 | + * - Class - class file to call function from? |
|
44 | + * - Main Callback - call back for main section |
|
45 | + * - Main Section Title - main section title |
|
46 | + * - Sidebar Callback - callback for the sidebar section |
|
47 | + * - Sidebar Title - title of the sidebar section |
|
48 | + * - Class - class to reference funtions out of (optiona, if left blank functions should be defined in functions.php (or outside of a class)) |
|
49 | + **/ |
|
50 | 50 | public static function add_edit_form_section( $section_array=array() ) { |
51 | 51 | if( !empty( $section_array ) ) { |
52 | 52 | $section_data = wp_parse_args( array() , $section_array ); |
@@ -59,11 +59,11 @@ discard block |
||
59 | 59 | } |
60 | 60 | |
61 | 61 | /** |
62 | - * Check if the custom section is single or two columns (with sidebar) |
|
63 | - * @since 6.0 |
|
64 | - * @Parameters: |
|
65 | - * - Section Data - the array of data associated with the custom field you've set up |
|
66 | - */ |
|
62 | + * Check if the custom section is single or two columns (with sidebar) |
|
63 | + * @since 6.0 |
|
64 | + * @Parameters: |
|
65 | + * - Section Data - the array of data associated with the custom field you've set up |
|
66 | + */ |
|
67 | 67 | public static function is_custom_section_two_column( $custom_section_data ) { |
68 | 68 | // print_r( $custom_section_data ); |
69 | 69 | $value = ( isset( $custom_section_data['sidebar_title'] ) && isset( $custom_section_data['sidebar_fields'] ) && !empty( $custom_section_data['sidebar_fields'] ) ) ? true : false; |
@@ -302,9 +302,9 @@ |
||
302 | 302 | ?></ul><?php |
303 | 303 | } |
304 | 304 | /** |
305 | - * Custom action hook for our add-ons to hook into |
|
306 | - * @since 6.0.3.8 |
|
307 | - */ |
|
305 | + * Custom action hook for our add-ons to hook into |
|
306 | + * @since 6.0.3.8 |
|
307 | + */ |
|
308 | 308 | do_action( 'yikes-mailchimp-list-form-fields-metabox' ); |
309 | 309 | ?> |
310 | 310 |
@@ -118,8 +118,8 @@ |
||
118 | 118 | } |
119 | 119 | |
120 | 120 | /** |
121 | - * Save changes to a field's label |
|
122 | - */ |
|
121 | + * Save changes to a field's label |
|
122 | + */ |
|
123 | 123 | public function save_field_label_edits() { |
124 | 124 | |
125 | 125 | // Capture our $_POST variables |
@@ -179,19 +179,19 @@ |
||
179 | 179 | } |
180 | 180 | |
181 | 181 | /** |
182 | - * Update a merge field for a particular list |
|
183 | - * |
|
184 | - * @author Kevin Utz |
|
185 | - * |
|
186 | - * @since 6.3.3 |
|
187 | - * |
|
188 | - * @param string | $list_id | The ID of the MailChimp list |
|
189 | - * @param string | $field_id | The ID of the merge field |
|
190 | - * @param array | $field_data | An array of field data constituting the body of our API request |
|
191 | - * @param bool | $clear_transient | Flag whether we should delete the transients associated with this list |
|
192 | - * |
|
193 | - * @return array | WP_Error |
|
194 | - */ |
|
182 | + * Update a merge field for a particular list |
|
183 | + * |
|
184 | + * @author Kevin Utz |
|
185 | + * |
|
186 | + * @since 6.3.3 |
|
187 | + * |
|
188 | + * @param string | $list_id | The ID of the MailChimp list |
|
189 | + * @param string | $field_id | The ID of the merge field |
|
190 | + * @param array | $field_data | An array of field data constituting the body of our API request |
|
191 | + * @param bool | $clear_transient | Flag whether we should delete the transients associated with this list |
|
192 | + * |
|
193 | + * @return array | WP_Error |
|
194 | + */ |
|
195 | 195 | public function update_merge_field( $list_id, $field_id, $field_data, $clear_transient = true ) { |
196 | 196 | $path = "{$this->base_path}/{$list_id}/merge-fields/{$field_id}"; |
197 | 197 | $field = $this->patch_to_api( $path, $field_data ); |
@@ -70,10 +70,10 @@ discard block |
||
70 | 70 | } |
71 | 71 | |
72 | 72 | /** |
73 | - * Create our own custom the_content(); filter to prevent plugins and such from hooking in where not wanted |
|
74 | - * |
|
75 | - * @since 6.0.3 |
|
76 | - */ |
|
73 | + * Create our own custom the_content(); filter to prevent plugins and such from hooking in where not wanted |
|
74 | + * |
|
75 | + * @since 6.0.3 |
|
76 | + */ |
|
77 | 77 | public function yikes_custom_frontend_content_filter() { |
78 | 78 | add_filter( 'yikes-mailchimp-frontend-content', 'wptexturize' ); |
79 | 79 | add_filter( 'yikes-mailchimp-frontend-content', 'convert_smilies' ); |
@@ -90,7 +90,7 @@ discard block |
||
90 | 90 | * load our checkbox classes |
91 | 91 | * |
92 | 92 | * @since 6.0.0 |
93 | - **/ |
|
93 | + **/ |
|
94 | 94 | public function load_checkbox_integration_classes() { |
95 | 95 | // store our options |
96 | 96 | $integrations = get_option( 'optin-checkbox-init' , array() ); |
@@ -154,9 +154,9 @@ discard block |
||
154 | 154 | } |
155 | 155 | |
156 | 156 | /** |
157 | - * If login is required, abort |
|
158 | - * @since 6.0.3.8 |
|
159 | - */ |
|
157 | + * If login is required, abort |
|
158 | + * @since 6.0.3.8 |
|
159 | + */ |
|
160 | 160 | if( $form_login_required ) { |
161 | 161 | if( apply_filters( 'yikes-mailchimp-required-login-requirement', ! is_user_logged_in() ) ) { |
162 | 162 | ob_start(); |
@@ -171,9 +171,9 @@ discard block |
||
171 | 171 | } |
172 | 172 | |
173 | 173 | /** |
174 | - * Check if schedule is set for this form |
|
175 | - * @since 6.0.3.8 |
|
176 | - */ |
|
174 | + * Check if schedule is set for this form |
|
175 | + * @since 6.0.3.8 |
|
176 | + */ |
|
177 | 177 | if( $form_schedule_state ) { |
178 | 178 | // store current date |
179 | 179 | $current_date = strtotime( current_time( 'm/d/Y g:iA' ) ); |
@@ -226,8 +226,8 @@ discard block |
||
226 | 226 | } |
227 | 227 | |
228 | 228 | /** |
229 | - * Check for form inline parameter |
|
230 | - */ |
|
229 | + * Check for form inline parameter |
|
230 | + */ |
|
231 | 231 | $form_inline = ( $atts['inline'] == 1 || $atts['inline'] == 'true' || get_theme_mod( 'form-inline-' . $form_id, '' ) === true ); // form-inline-{$form_id} comes from customizer extension |
232 | 232 | // recheck from our form options |
233 | 233 | if ( ! $form_inline ) { |
@@ -291,21 +291,21 @@ discard block |
||
291 | 291 | /**** Set up any filter'able content (that needs to be filtered before the rest of the logic kicks off) ****/ |
292 | 292 | |
293 | 293 | /** |
294 | - * yikes-mailchimp-countries-with-zip |
|
295 | - * |
|
296 | - * Filter which countries show the zip field |
|
297 | - * |
|
298 | - * @param array | An array of country codes that the zip field will appear for - default: US, GB, CA |
|
299 | - * Note: please return the array with the country code as the KEY! This allows for optimal searching. |
|
300 | - * @param int | $form_id |
|
301 | - */ |
|
294 | + * yikes-mailchimp-countries-with-zip |
|
295 | + * |
|
296 | + * Filter which countries show the zip field |
|
297 | + * |
|
298 | + * @param array | An array of country codes that the zip field will appear for - default: US, GB, CA |
|
299 | + * Note: please return the array with the country code as the KEY! This allows for optimal searching. |
|
300 | + * @param int | $form_id |
|
301 | + */ |
|
302 | 302 | $countries_with_zip_code_field = apply_filters( 'yikes-mailchimp-countries-with-zip', |
303 | 303 | array( 'US' => 'US', 'GB' => 'GB', 'CA' => 'CA', |
304 | - 'IE' => 'IE', 'CN' => 'CN', 'IN' => 'IN', |
|
305 | - 'AU' => 'AU', 'BR' => 'BR', 'MX' => 'MX', |
|
306 | - 'IT' => 'IT', 'NZ' => 'NZ', 'JP' => 'JP', |
|
307 | - 'FR' => 'FR', 'GR' => 'GR', 'DE' => 'DE', |
|
308 | - 'NL' => 'NL', 'PT' => 'PT', 'ES' => 'ES' |
|
304 | + 'IE' => 'IE', 'CN' => 'CN', 'IN' => 'IN', |
|
305 | + 'AU' => 'AU', 'BR' => 'BR', 'MX' => 'MX', |
|
306 | + 'IT' => 'IT', 'NZ' => 'NZ', 'JP' => 'JP', |
|
307 | + 'FR' => 'FR', 'GR' => 'GR', 'DE' => 'DE', |
|
308 | + 'NL' => 'NL', 'PT' => 'PT', 'ES' => 'ES' |
|
309 | 309 | ), $form_id |
310 | 310 | ); |
311 | 311 | |
@@ -532,14 +532,14 @@ discard block |
||
532 | 532 | $description .= '</p>'; |
533 | 533 | |
534 | 534 | /** |
535 | - * 'yikes-mailchimp-' . $field['merge'] . '-description-html' (e.g. yikes-mailchimp-FNAME-description-html) |
|
536 | - * |
|
537 | - * Filter the description HTML block |
|
538 | - * |
|
539 | - * @param string | $description | The full HTML description block |
|
540 | - * @param string | $field['description'] | The field's description text |
|
541 | - * @param int | $form_id |
|
542 | - */ |
|
535 | + * 'yikes-mailchimp-' . $field['merge'] . '-description-html' (e.g. yikes-mailchimp-FNAME-description-html) |
|
536 | + * |
|
537 | + * Filter the description HTML block |
|
538 | + * |
|
539 | + * @param string | $description | The full HTML description block |
|
540 | + * @param string | $field['description'] | The field's description text |
|
541 | + * @param int | $form_id |
|
542 | + */ |
|
543 | 543 | $description = apply_filters( 'yikes-mailchimp-' . $field['merge'] . '-description-html', $description, esc_attr( stripslashes( $field['description'] ) ), $form_id ); |
544 | 544 | } |
545 | 545 | |
@@ -684,13 +684,13 @@ discard block |
||
684 | 684 | $required_fields = array( 'addr1' => 'address' , 'addr2' => 'address 2', 'city' => 'city', 'state' =>'state', 'zip' =>'zip' , 'country' => 'country' ); |
685 | 685 | |
686 | 686 | /** |
687 | - * Filter to control the default country (the option pre-selected in the country dropdown). |
|
688 | - * |
|
689 | - * 'yikes-mailchimp-default-country-value' |
|
690 | - * |
|
691 | - * @param string | $country_slug | The slug of the desired default country. Default: 'US' |
|
692 | - * @param int | $form_id | ID of the form |
|
693 | - */ |
|
687 | + * Filter to control the default country (the option pre-selected in the country dropdown). |
|
688 | + * |
|
689 | + * 'yikes-mailchimp-default-country-value' |
|
690 | + * |
|
691 | + * @param string | $country_slug | The slug of the desired default country. Default: 'US' |
|
692 | + * @param int | $form_id | ID of the form |
|
693 | + */ |
|
694 | 694 | $default_country = apply_filters( 'yikes-mailchimp-default-country-value', 'US', $form_id ); |
695 | 695 | |
696 | 696 | // <!-- Description Above --> |
@@ -756,15 +756,15 @@ discard block |
||
756 | 756 | <?php |
757 | 757 | $state_and_province_list = file_get_contents( YIKES_MC_PATH . 'public/partials/shortcodes/templates/state-and-province-dropdown.php' ); |
758 | 758 | /** |
759 | - * 'yikes-mailchimp-state-province-list' |
|
760 | - * |
|
761 | - * Filter the HTML options for the states dropdown |
|
762 | - * |
|
763 | - * @param string | $state_and_province_list | HTML string of state/province options |
|
764 | - * @param int | $form_id | The form ID |
|
765 | - * |
|
766 | - * @return string | $state_and_province_list | Filtered HTML string of state/province options |
|
767 | - */ |
|
759 | + * 'yikes-mailchimp-state-province-list' |
|
760 | + * |
|
761 | + * Filter the HTML options for the states dropdown |
|
762 | + * |
|
763 | + * @param string | $state_and_province_list | HTML string of state/province options |
|
764 | + * @param int | $form_id | The form ID |
|
765 | + * |
|
766 | + * @return string | $state_and_province_list | Filtered HTML string of state/province options |
|
767 | + */ |
|
768 | 768 | echo apply_filters( 'yikes-mailchimp-state-province-list', $state_and_province_list, $form_id ); |
769 | 769 | |
770 | 770 | ?> |
@@ -797,17 +797,17 @@ discard block |
||
797 | 797 | } else { |
798 | 798 | |
799 | 799 | /** |
800 | - * A filter to set the default zip code value. |
|
801 | - * |
|
802 | - * U.S. users may want to default their subscribers. |
|
803 | - * However, this filter is more for non-U.S. users, where the zip field is hidden. |
|
804 | - * MailChimp requires a zip code (for all submissions/countries), so this filter allows users users to set a default value. |
|
805 | - * |
|
806 | - * 'yikes-mailchimp-default-zip-code' |
|
807 | - * |
|
808 | - * @param string | $zip | A value to pre-populate the zip code with. |
|
809 | - * @param int | $form_id | ID of the form |
|
810 | - */ |
|
800 | + * A filter to set the default zip code value. |
|
801 | + * |
|
802 | + * U.S. users may want to default their subscribers. |
|
803 | + * However, this filter is more for non-U.S. users, where the zip field is hidden. |
|
804 | + * MailChimp requires a zip code (for all submissions/countries), so this filter allows users users to set a default value. |
|
805 | + * |
|
806 | + * 'yikes-mailchimp-default-zip-code' |
|
807 | + * |
|
808 | + * @param string | $zip | A value to pre-populate the zip code with. |
|
809 | + * @param int | $form_id | ID of the form |
|
810 | + */ |
|
811 | 811 | $zip_value = apply_filters( 'yikes-mailchimp-default-zip-code', '', $form_id ); |
812 | 812 | } |
813 | 813 | ?> |
@@ -1038,14 +1038,14 @@ discard block |
||
1038 | 1038 | $description .= '</p>'; |
1039 | 1039 | |
1040 | 1040 | /** |
1041 | - * 'yikes-mailchimp-' . $field['group_id'] . '-description-html' (e.g. yikes-mailchimp-0ab8f8c84b-description-html) |
|
1042 | - * |
|
1043 | - * Filter the description HTML block |
|
1044 | - * |
|
1045 | - * @param string | $description | The full HTML description block |
|
1046 | - * @param string | $field['description'] | The field's description text |
|
1047 | - * @param int | $form_id |
|
1048 | - */ |
|
1041 | + * 'yikes-mailchimp-' . $field['group_id'] . '-description-html' (e.g. yikes-mailchimp-0ab8f8c84b-description-html) |
|
1042 | + * |
|
1043 | + * Filter the description HTML block |
|
1044 | + * |
|
1045 | + * @param string | $description | The full HTML description block |
|
1046 | + * @param string | $field['description'] | The field's description text |
|
1047 | + * @param int | $form_id |
|
1048 | + */ |
|
1049 | 1049 | $description = apply_filters( 'yikes-mailchimp-' . $field['group_id'] . '-description-html', $description, esc_attr( stripslashes( $field['description'] ) ), $form_id ); |
1050 | 1050 | } |
1051 | 1051 |
@@ -510,10 +510,10 @@ discard block |
||
510 | 510 | } |
511 | 511 | |
512 | 512 | /** |
513 | - * Dismiss the migrate options notice (incase the user wants to do things manually) |
|
514 | - * |
|
515 | - * @since 6.0.0 |
|
516 | - **/ |
|
513 | + * Dismiss the migrate options notice (incase the user wants to do things manually) |
|
514 | + * |
|
515 | + * @since 6.0.0 |
|
516 | + **/ |
|
517 | 517 | public function yikes_easy_mailchimp_dismiss_option_migrate() { |
518 | 518 | // delete the options and allow the user to manually update things. |
519 | 519 | |
@@ -618,7 +618,7 @@ discard block |
||
618 | 618 | yikes_easy_mailchimp_stop_bugging_me() |
619 | 619 | Remove the Review us notification when user clicks 'Dismiss' |
620 | 620 | @since v3.1.1 |
621 | - */ |
|
621 | + */ |
|
622 | 622 | public function yikes_easy_mailchimp_stop_bugging_me() { |
623 | 623 | if ( isset( $_GET['yikes_easy_mc_icons_nobug'] ) && (int) filter_var( $_GET['yikes_easy_mc_icons_nobug'], FILTER_SANITIZE_NUMBER_INT ) === 1 ) { |
624 | 624 | add_option( 'yikes_easy_mailchimp_review_stop_bugging_me', true ); |
@@ -885,9 +885,9 @@ discard block |
||
885 | 885 | } |
886 | 886 | |
887 | 887 | /** |
888 | - * Register our admin pages |
|
889 | - * used to display data back to the user |
|
890 | - **/ |
|
888 | + * Register our admin pages |
|
889 | + * used to display data back to the user |
|
890 | + **/ |
|
891 | 891 | public function register_admin_pages() { |
892 | 892 | |
893 | 893 | /* Top Level Menu 'Easy MailChimp' */ |
@@ -1016,28 +1016,28 @@ discard block |
||
1016 | 1016 | } |
1017 | 1017 | |
1018 | 1018 | /** |
1019 | - * Generate Us Easy MailChimp Manage Forms Page |
|
1020 | - * |
|
1021 | - * @since 1.0.0 |
|
1022 | - */ |
|
1019 | + * Generate Us Easy MailChimp Manage Forms Page |
|
1020 | + * |
|
1021 | + * @since 1.0.0 |
|
1022 | + */ |
|
1023 | 1023 | function generateManageFormsPage() { |
1024 | 1024 | require_once YIKES_MC_PATH . 'admin/partials/menu/manage-forms.php'; // include our manage forms page |
1025 | 1025 | } |
1026 | 1026 | |
1027 | 1027 | /** |
1028 | - * Generate Us Easy MailChimp Manage Lists Page |
|
1029 | - * |
|
1030 | - * @since 1.0.0 |
|
1031 | - */ |
|
1028 | + * Generate Us Easy MailChimp Manage Lists Page |
|
1029 | + * |
|
1030 | + * @since 1.0.0 |
|
1031 | + */ |
|
1032 | 1032 | function generateManageListsPage() { |
1033 | 1033 | require_once YIKES_MC_PATH . 'admin/partials/menu/manage-lists.php'; // include our lists page |
1034 | 1034 | } |
1035 | 1035 | |
1036 | 1036 | /** |
1037 | - * Generate Us Easy MailChimp Support Page |
|
1038 | - * |
|
1039 | - * @since 1.0.0 |
|
1040 | - */ |
|
1037 | + * Generate Us Easy MailChimp Support Page |
|
1038 | + * |
|
1039 | + * @since 1.0.0 |
|
1040 | + */ |
|
1041 | 1041 | function generateSupportPage() { |
1042 | 1042 | |
1043 | 1043 | wp_enqueue_script( 'yikes-inc-easy-mailchimp-extender-support-scripts', plugin_dir_url( __FILE__ ) . 'js/support.js', array( 'jquery' ), $this->version, false ); |
@@ -1045,37 +1045,37 @@ discard block |
||
1045 | 1045 | } |
1046 | 1046 | |
1047 | 1047 | /** |
1048 | - * Generate Us Easy MailChimp Edit Form Page |
|
1049 | - * |
|
1050 | - * @since 1.0.0 |
|
1051 | - */ |
|
1048 | + * Generate Us Easy MailChimp Edit Form Page |
|
1049 | + * |
|
1050 | + * @since 1.0.0 |
|
1051 | + */ |
|
1052 | 1052 | function generateEditFormPage() { |
1053 | 1053 | require_once YIKES_MC_PATH . 'admin/partials/edit-form.php'; // include our options page |
1054 | 1054 | } |
1055 | 1055 | |
1056 | 1056 | /** |
1057 | - * Generate Us Easy MailChimp View List Page |
|
1058 | - * |
|
1059 | - * @since 1.0.0 |
|
1060 | - */ |
|
1057 | + * Generate Us Easy MailChimp View List Page |
|
1058 | + * |
|
1059 | + * @since 1.0.0 |
|
1060 | + */ |
|
1061 | 1061 | function generateViewListPage() { |
1062 | 1062 | require_once YIKES_MC_PATH . 'admin/partials/view-list.php'; // include our options page |
1063 | 1063 | } |
1064 | 1064 | |
1065 | 1065 | /** |
1066 | - * Generate Us Easy MailChimp View User Page |
|
1067 | - * |
|
1068 | - * @since 1.0.0 |
|
1069 | - */ |
|
1066 | + * Generate Us Easy MailChimp View User Page |
|
1067 | + * |
|
1068 | + * @since 1.0.0 |
|
1069 | + */ |
|
1070 | 1070 | function generateViewUserPage() { |
1071 | 1071 | require_once YIKES_MC_PATH . 'admin/partials/view-user.php'; // include our options page |
1072 | 1072 | } |
1073 | 1073 | |
1074 | 1074 | /** |
1075 | - * Register our plugin settings, and display them on our settings page |
|
1076 | - * |
|
1077 | - * @since v.5.4 |
|
1078 | - **/ |
|
1075 | + * Register our plugin settings, and display them on our settings page |
|
1076 | + * |
|
1077 | + * @since v.5.4 |
|
1078 | + **/ |
|
1079 | 1079 | function yikes_easy_mc_settings_init() { |
1080 | 1080 | |
1081 | 1081 | /* Register General Settings Section */ |
@@ -1193,9 +1193,9 @@ discard block |
||
1193 | 1193 | } |
1194 | 1194 | |
1195 | 1195 | /** |
1196 | - * Options Sanitization & Validation |
|
1197 | - * @since complete re-write |
|
1198 | - **/ |
|
1196 | + * Options Sanitization & Validation |
|
1197 | + * @since complete re-write |
|
1198 | + **/ |
|
1199 | 1199 | function yikes_mc_validate_api_key( $input ) { |
1200 | 1200 | if ( $input === '' ) { |
1201 | 1201 | update_option( 'yikes-mc-api-validation', 'invalid_api_key' ); |
@@ -1227,20 +1227,20 @@ discard block |
||
1227 | 1227 | } |
1228 | 1228 | |
1229 | 1229 | /** |
1230 | - * Generate Us Easy Forms for MailChimp Options Page |
|
1231 | - * |
|
1232 | - * @since 1.0.0 |
|
1233 | - */ |
|
1230 | + * Generate Us Easy Forms for MailChimp Options Page |
|
1231 | + * |
|
1232 | + * @since 1.0.0 |
|
1233 | + */ |
|
1234 | 1234 | function generatePageOptions() { |
1235 | 1235 | require_once YIKES_MC_PATH . 'admin/partials/menu/options.php'; // include our options page |
1236 | 1236 | } |
1237 | 1237 | |
1238 | 1238 | /** |
1239 | - * Check if users API key is valid, if not |
|
1240 | - * this function will apply a disabled attribute |
|
1241 | - * to form fields. (input, dropdowns, buttons etc.) |
|
1242 | - * @since v5.5 re-write |
|
1243 | - **/ |
|
1239 | + * Check if users API key is valid, if not |
|
1240 | + * this function will apply a disabled attribute |
|
1241 | + * to form fields. (input, dropdowns, buttons etc.) |
|
1242 | + * @since v5.5 re-write |
|
1243 | + **/ |
|
1244 | 1244 | public function is_user_mc_api_valid_form( $echo = true ) { |
1245 | 1245 | if ( $echo == true ) { |
1246 | 1246 | if ( get_option( 'yikes-mc-api-validation', 'invalid_api_key' ) == 'invalid_api_key' ) { |
@@ -1280,7 +1280,7 @@ discard block |
||
1280 | 1280 | * Migrate our old options , to the new options API |
1281 | 1281 | * moving from 5.5 and beyond.. |
1282 | 1282 | * @since |
1283 | - */ |
|
1283 | + */ |
|
1284 | 1284 | public function migrate_old_yks_mc_options() { |
1285 | 1285 | // include our migrate options helper file |
1286 | 1286 | include_once YIKES_MC_PATH . 'admin/partials/upgrade-helpers/upgrade-migrate-options.php'; |
@@ -1289,7 +1289,7 @@ discard block |
||
1289 | 1289 | /** |
1290 | 1290 | Admin Notices |
1291 | 1291 | - Notifications displayed at the top of admin pages, back to the user |
1292 | - **/ |
|
1292 | + **/ |
|
1293 | 1293 | |
1294 | 1294 | /** |
1295 | 1295 | * Check for existing plugin options |
@@ -1348,12 +1348,12 @@ discard block |
||
1348 | 1348 | * - http://stackoverflow.com/questions/6661530/php-multi-dimensional-array-search |
1349 | 1349 | */ |
1350 | 1350 | function findMCListID($id, $array) { |
1351 | - foreach ($array as $key => $val) { |
|
1352 | - if ($val['id'] === $id) { |
|
1353 | - return $key; |
|
1354 | - } |
|
1355 | - } |
|
1356 | - return null; |
|
1351 | + foreach ($array as $key => $val) { |
|
1352 | + if ($val['id'] === $id) { |
|
1353 | + return $key; |
|
1354 | + } |
|
1355 | + } |
|
1356 | + return null; |
|
1357 | 1357 | } // end |
1358 | 1358 | |
1359 | 1359 | /* Ajax Migrate Options */ |
@@ -1591,13 +1591,13 @@ discard block |
||
1591 | 1591 | <?php |
1592 | 1592 | |
1593 | 1593 | /** |
1594 | - * yikes-mailchimp-excluded-redirect-post-types |
|
1595 | - * |
|
1596 | - * Filter the post types that will not show on the redirect list dropdown. |
|
1597 | - * |
|
1598 | - * @param array | $excluded_post_types | The array of default excluded post types |
|
1599 | - * @return array| $excluded_post_types | The array of user-defined excluded post types |
|
1600 | - */ |
|
1594 | + * yikes-mailchimp-excluded-redirect-post-types |
|
1595 | + * |
|
1596 | + * Filter the post types that will not show on the redirect list dropdown. |
|
1597 | + * |
|
1598 | + * @param array | $excluded_post_types | The array of default excluded post types |
|
1599 | + * @return array| $excluded_post_types | The array of user-defined excluded post types |
|
1600 | + */ |
|
1601 | 1601 | $excluded_post_types = array( 'attachment', 'revision', 'nav_menu_item', 'shop_order', 'shop_order_refund', 'custom_css', 'customize_changeset', 'forum', 'topic', 'reply' ); |
1602 | 1602 | $excluded_post_types = apply_filters( 'yikes-mailchimp-excluded-redirect-post-types', $excluded_post_types ); |
1603 | 1603 | |
@@ -1733,9 +1733,9 @@ discard block |
||
1733 | 1733 | } |
1734 | 1734 | |
1735 | 1735 | /** |
1736 | - * Custom action hook for our extensions to hook into |
|
1737 | - * @parameter get_current_screen() current screen information |
|
1738 | - */ |
|
1736 | + * Custom action hook for our extensions to hook into |
|
1737 | + * @parameter get_current_screen() current screen information |
|
1738 | + */ |
|
1739 | 1739 | do_action( 'yikes-mailchimp-admin-sidebar', get_current_screen() ); |
1740 | 1740 | |
1741 | 1741 | } |
@@ -2646,13 +2646,13 @@ discard block |
||
2646 | 2646 | $result = $this->form_interface->create_form( $form_data ); |
2647 | 2647 | |
2648 | 2648 | /** |
2649 | - * `yikes-mailchimp-after-duplicating-form` |
|
2650 | - * |
|
2651 | - * @param $post_id_to_clone | int | ID of the original form |
|
2652 | - * @param $result | mixed | ID of the new form OR false if the operation failed |
|
2653 | - * @param $form_data | array | Array of the form data |
|
2654 | - * |
|
2655 | - */ |
|
2649 | + * `yikes-mailchimp-after-duplicating-form` |
|
2650 | + * |
|
2651 | + * @param $post_id_to_clone | int | ID of the original form |
|
2652 | + * @param $result | mixed | ID of the new form OR false if the operation failed |
|
2653 | + * @param $form_data | array | Array of the form data |
|
2654 | + * |
|
2655 | + */ |
|
2656 | 2656 | do_action( 'yikes-mailchimp-after-duplicating-form', $post_id_to_clone, $result, $form_data ); |
2657 | 2657 | |
2658 | 2658 | if ( false === $result ) { |
@@ -72,12 +72,12 @@ discard block |
||
72 | 72 | $precheck = isset( $checkbox_options[ $this->type ]['precheck'] ) && 'true' === $checkbox_options[ $this->type ]['precheck'] ? '1' : '0'; |
73 | 73 | |
74 | 74 | /** |
75 | - * Filter where the checkbox goes. |
|
76 | - * |
|
77 | - * See this WooCo article for possible values: https://docs.woocommerce.com/document/tutorial-customising-checkout-fields-using-actions-and-filters/ |
|
78 | - * |
|
79 | - * @param string | Which set of fields the checkbox should go into |
|
80 | - */ |
|
75 | + * Filter where the checkbox goes. |
|
76 | + * |
|
77 | + * See this WooCo article for possible values: https://docs.woocommerce.com/document/tutorial-customising-checkout-fields-using-actions-and-filters/ |
|
78 | + * |
|
79 | + * @param string | Which set of fields the checkbox should go into |
|
80 | + */ |
|
81 | 81 | $field_placement = apply_filters( 'yikes-mailchimp-wooco-integration-checkbox-placement', 'billing' ); |
82 | 82 | |
83 | 83 | $yikes_checkbox = array( |
@@ -89,13 +89,13 @@ discard block |
||
89 | 89 | ); |
90 | 90 | |
91 | 91 | /** |
92 | - * Filter the checkbox data. |
|
93 | - * |
|
94 | - * See this WooCo article for possible values: https://docs.woocommerce.com/document/tutorial-customising-checkout-fields-using-actions-and-filters/ |
|
95 | - * |
|
96 | - * @param array $yikes_checkbox The checkbox's fields. |
|
97 | - * @return array $yikes_checkbox The checkbox's fields. |
|
98 | - */ |
|
92 | + * Filter the checkbox data. |
|
93 | + * |
|
94 | + * See this WooCo article for possible values: https://docs.woocommerce.com/document/tutorial-customising-checkout-fields-using-actions-and-filters/ |
|
95 | + * |
|
96 | + * @param array $yikes_checkbox The checkbox's fields. |
|
97 | + * @return array $yikes_checkbox The checkbox's fields. |
|
98 | + */ |
|
99 | 99 | $yikes_checkbox = apply_filters( 'yikes_mailchimp_wooco_integration_checkbox_field', $yikes_checkbox, $checkbox_options[ $this->type ] ); |
100 | 100 | |
101 | 101 | $fields[ $field_placement ][ 'yikes_mailchimp_checkbox_' . $this->type ] = $yikes_checkbox; |
@@ -3,234 +3,234 @@ discard block |
||
3 | 3 | class Yikes_Inc_Easy_MailChimp_Extender_Process_Submission_Handler { |
4 | 4 | |
5 | 5 | /** |
6 | - * A flag signifying whether we're dealing with an AJAX submission or standard form submission |
|
7 | - * |
|
8 | - * @since 6.3.0 |
|
9 | - * @access protected |
|
10 | - * @var bool | $is_ajax |
|
11 | - */ |
|
6 | + * A flag signifying whether we're dealing with an AJAX submission or standard form submission |
|
7 | + * |
|
8 | + * @since 6.3.0 |
|
9 | + * @access protected |
|
10 | + * @var bool | $is_ajax |
|
11 | + */ |
|
12 | 12 | protected $is_ajax; |
13 | 13 | |
14 | 14 | /**** Hardcoded Internal Variables ****/ |
15 | 15 | |
16 | 16 | /** |
17 | - * An array of form fields we don't process |
|
18 | - * |
|
19 | - * @since 6.3.0 |
|
20 | - * @access protected |
|
21 | - * @var array | $skipped_form_fields |
|
22 | - */ |
|
17 | + * An array of form fields we don't process |
|
18 | + * |
|
19 | + * @since 6.3.0 |
|
20 | + * @access protected |
|
21 | + * @var array | $skipped_form_fields |
|
22 | + */ |
|
23 | 23 | protected $skipped_form_fields; |
24 | 24 | |
25 | 25 | /**** Form Variables ****/ |
26 | 26 | |
27 | 27 | /** |
28 | - * The ID of the corresponding YIKES MailChimp form |
|
29 | - * |
|
30 | - * @since 6.3.0 |
|
31 | - * @access public |
|
32 | - * @var int | $form_id |
|
33 | - */ |
|
28 | + * The ID of the corresponding YIKES MailChimp form |
|
29 | + * |
|
30 | + * @since 6.3.0 |
|
31 | + * @access public |
|
32 | + * @var int | $form_id |
|
33 | + */ |
|
34 | 34 | public $form_id; |
35 | 35 | |
36 | 36 | /** |
37 | - * The ID of the corresponding MailChimp list |
|
38 | - * |
|
39 | - * @since 6.3.0 |
|
40 | - * @access public |
|
41 | - * @var int | $list_id |
|
42 | - */ |
|
37 | + * The ID of the corresponding MailChimp list |
|
38 | + * |
|
39 | + * @since 6.3.0 |
|
40 | + * @access public |
|
41 | + * @var int | $list_id |
|
42 | + */ |
|
43 | 43 | public $list_id; |
44 | 44 | |
45 | 45 | /** |
46 | - * The submitted email |
|
47 | - * |
|
48 | - * @since 6.3.0 |
|
49 | - * @access public |
|
50 | - * @var string | $email |
|
51 | - */ |
|
46 | + * The submitted email |
|
47 | + * |
|
48 | + * @since 6.3.0 |
|
49 | + * @access public |
|
50 | + * @var string | $email |
|
51 | + */ |
|
52 | 52 | public $email; |
53 | 53 | |
54 | 54 | /** |
55 | - * The array of error messages defined by the user and attached to this form |
|
56 | - * |
|
57 | - * @since 6.3.0 |
|
58 | - * @access public |
|
59 | - * @var array | $error_messages |
|
60 | - */ |
|
55 | + * The array of error messages defined by the user and attached to this form |
|
56 | + * |
|
57 | + * @since 6.3.0 |
|
58 | + * @access public |
|
59 | + * @var array | $error_messages |
|
60 | + */ |
|
61 | 61 | public $error_messages; |
62 | 62 | |
63 | 63 | /**** Default Error Messages ****/ |
64 | 64 | |
65 | 65 | /** |
66 | - * The error message for no form ID |
|
67 | - * |
|
68 | - * @since 6.3.0 |
|
69 | - * @access public |
|
70 | - * @var string | $handle_empty_form_id_message |
|
71 | - */ |
|
66 | + * The error message for no form ID |
|
67 | + * |
|
68 | + * @since 6.3.0 |
|
69 | + * @access public |
|
70 | + * @var string | $handle_empty_form_id_message |
|
71 | + */ |
|
72 | 72 | public $handle_empty_form_id_message; |
73 | 73 | |
74 | 74 | /** |
75 | - * The error message for no form found |
|
76 | - * |
|
77 | - * @since 6.3.0 |
|
78 | - * @access public |
|
79 | - * @var string | $handle_empty_form_message |
|
80 | - */ |
|
75 | + * The error message for no form found |
|
76 | + * |
|
77 | + * @since 6.3.0 |
|
78 | + * @access public |
|
79 | + * @var string | $handle_empty_form_message |
|
80 | + */ |
|
81 | 81 | public $handle_empty_form_message; |
82 | 82 | |
83 | 83 | /** |
84 | - * The error message for missing form fields |
|
85 | - * |
|
86 | - * @since 6.3.0 |
|
87 | - * @access public |
|
88 | - * @var string | $handle_empty_fields_generic_message |
|
89 | - */ |
|
84 | + * The error message for missing form fields |
|
85 | + * |
|
86 | + * @since 6.3.0 |
|
87 | + * @access public |
|
88 | + * @var string | $handle_empty_fields_generic_message |
|
89 | + */ |
|
90 | 90 | public $handle_empty_fields_generic_message; |
91 | 91 | |
92 | 92 | /** |
93 | - * The error message for missing $list_handler class |
|
94 | - * |
|
95 | - * @since 6.3.0 |
|
96 | - * @access public |
|
97 | - * @var string | $handle_empty_list_handler_message |
|
98 | - */ |
|
93 | + * The error message for missing $list_handler class |
|
94 | + * |
|
95 | + * @since 6.3.0 |
|
96 | + * @access public |
|
97 | + * @var string | $handle_empty_list_handler_message |
|
98 | + */ |
|
99 | 99 | public $handle_empty_list_handler_message; |
100 | 100 | |
101 | 101 | /** |
102 | - * The error message for no email |
|
103 | - * |
|
104 | - * @since 6.3.0 |
|
105 | - * @access public |
|
106 | - * @var string | $handle_empty_email_message |
|
107 | - */ |
|
102 | + * The error message for no email |
|
103 | + * |
|
104 | + * @since 6.3.0 |
|
105 | + * @access public |
|
106 | + * @var string | $handle_empty_email_message |
|
107 | + */ |
|
108 | 108 | public $handle_empty_email_message; |
109 | 109 | |
110 | 110 | /** |
111 | - * The error message for a filled in honeypot |
|
112 | - * |
|
113 | - * @since 6.3.0 |
|
114 | - * @access public |
|
115 | - * @var string | $handle_non_empty_honeypot_message |
|
116 | - */ |
|
111 | + * The error message for a filled in honeypot |
|
112 | + * |
|
113 | + * @since 6.3.0 |
|
114 | + * @access public |
|
115 | + * @var string | $handle_non_empty_honeypot_message |
|
116 | + */ |
|
117 | 117 | public $handle_non_empty_honeypot_message; |
118 | 118 | |
119 | 119 | /** |
120 | - * The error message for existing users trying to update when it's disallowed |
|
121 | - * |
|
122 | - * @since 6.3.0 |
|
123 | - * @access public |
|
124 | - * @var string | $handle_disallowed_existing_user_update_message |
|
125 | - */ |
|
120 | + * The error message for existing users trying to update when it's disallowed |
|
121 | + * |
|
122 | + * @since 6.3.0 |
|
123 | + * @access public |
|
124 | + * @var string | $handle_disallowed_existing_user_update_message |
|
125 | + */ |
|
126 | 126 | public $handle_disallowed_existing_user_update_message; |
127 | 127 | |
128 | 128 | /** |
129 | - * The first half of the error message for updating an existing user when it's done via a profile link |
|
130 | - * |
|
131 | - * @since 6.3.0 |
|
132 | - * @access public |
|
133 | - * @var string | $handle_updating_existing_user_message |
|
134 | - */ |
|
129 | + * The first half of the error message for updating an existing user when it's done via a profile link |
|
130 | + * |
|
131 | + * @since 6.3.0 |
|
132 | + * @access public |
|
133 | + * @var string | $handle_updating_existing_user_message |
|
134 | + */ |
|
135 | 135 | public $handle_updating_existing_user_message; |
136 | 136 | |
137 | 137 | /** |
138 | - * The second half of the error message (the link) for updating an existing user when it's done via a profile link |
|
139 | - * |
|
140 | - * @since 6.3.0 |
|
141 | - * @access public |
|
142 | - * @var string | $handle_updating_existing_user_link_message |
|
143 | - */ |
|
138 | + * The second half of the error message (the link) for updating an existing user when it's done via a profile link |
|
139 | + * |
|
140 | + * @since 6.3.0 |
|
141 | + * @access public |
|
142 | + * @var string | $handle_updating_existing_user_link_message |
|
143 | + */ |
|
144 | 144 | public $handle_updating_existing_user_link_message; |
145 | 145 | |
146 | 146 | /** |
147 | - * A default, generic error message |
|
148 | - * |
|
149 | - * @since 6.3.0 |
|
150 | - * @access public |
|
151 | - * @var string | $default_error_response_message |
|
152 | - */ |
|
147 | + * A default, generic error message |
|
148 | + * |
|
149 | + * @since 6.3.0 |
|
150 | + * @access public |
|
151 | + * @var string | $default_error_response_message |
|
152 | + */ |
|
153 | 153 | public $default_error_response_message; |
154 | 154 | |
155 | 155 | /** |
156 | - * The error message for not filling out a required form field |
|
157 | - * |
|
158 | - * @since 6.3.0 |
|
159 | - * @access public |
|
160 | - * @var string | $handle_empty_required_field_message |
|
161 | - */ |
|
156 | + * The error message for not filling out a required form field |
|
157 | + * |
|
158 | + * @since 6.3.0 |
|
159 | + * @access public |
|
160 | + * @var string | $handle_empty_required_field_message |
|
161 | + */ |
|
162 | 162 | public $handle_empty_required_field_message; |
163 | 163 | |
164 | 164 | /** |
165 | - * The error message for not filling out a required interest group |
|
166 | - * |
|
167 | - * @since 6.3.0 |
|
168 | - * @access public |
|
169 | - * @var string | $handle_empty_required_interest_group_message |
|
170 | - */ |
|
165 | + * The error message for not filling out a required interest group |
|
166 | + * |
|
167 | + * @since 6.3.0 |
|
168 | + * @access public |
|
169 | + * @var string | $handle_empty_required_interest_group_message |
|
170 | + */ |
|
171 | 171 | public $handle_empty_required_interest_group_message; |
172 | 172 | |
173 | 173 | /** |
174 | - * The error message for nonce failures |
|
175 | - * |
|
176 | - * @since 6.3.0 |
|
177 | - * @access public |
|
178 | - * @var string | $handle_nonce_message |
|
179 | - */ |
|
174 | + * The error message for nonce failures |
|
175 | + * |
|
176 | + * @since 6.3.0 |
|
177 | + * @access public |
|
178 | + * @var string | $handle_nonce_message |
|
179 | + */ |
|
180 | 180 | public $handle_nonce_message; |
181 | 181 | |
182 | 182 | /** |
183 | - * The error message for a recaptcha that is not checked/filled out |
|
184 | - * |
|
185 | - * @since 6.3.0 |
|
186 | - * @access public |
|
187 | - * @var string | $handle_nonce_message |
|
188 | - */ |
|
183 | + * The error message for a recaptcha that is not checked/filled out |
|
184 | + * |
|
185 | + * @since 6.3.0 |
|
186 | + * @access public |
|
187 | + * @var string | $handle_nonce_message |
|
188 | + */ |
|
189 | 189 | public $handle_non_filled_recaptcha_message_message; |
190 | 190 | |
191 | 191 | /** |
192 | - * The error message for recaptcha errors that we're not sure of |
|
193 | - * |
|
194 | - * @since 6.3.0 |
|
195 | - * @access public |
|
196 | - * @var string | $handle_nonce_message |
|
197 | - */ |
|
192 | + * The error message for recaptcha errors that we're not sure of |
|
193 | + * |
|
194 | + * @since 6.3.0 |
|
195 | + * @access public |
|
196 | + * @var string | $handle_nonce_message |
|
197 | + */ |
|
198 | 198 | public $generic_recaptcha_error_message; |
199 | 199 | |
200 | 200 | /**** Default Success Messages ****/ |
201 | 201 | |
202 | 202 | /** |
203 | - * The success message for single-optin forms |
|
204 | - * |
|
205 | - * @since 6.3.0 |
|
206 | - * @access public |
|
207 | - * @var string | $default_response_single_optin_success_message |
|
208 | - */ |
|
203 | + * The success message for single-optin forms |
|
204 | + * |
|
205 | + * @since 6.3.0 |
|
206 | + * @access public |
|
207 | + * @var string | $default_response_single_optin_success_message |
|
208 | + */ |
|
209 | 209 | public $default_response_single_optin_success_message; |
210 | 210 | |
211 | 211 | /** |
212 | - * The default success message for double-optin forms |
|
213 | - * |
|
214 | - * @since 6.3.0 |
|
215 | - * @access public |
|
216 | - * @var string | $default_response_double_optin_success_message |
|
217 | - */ |
|
212 | + * The default success message for double-optin forms |
|
213 | + * |
|
214 | + * @since 6.3.0 |
|
215 | + * @access public |
|
216 | + * @var string | $default_response_double_optin_success_message |
|
217 | + */ |
|
218 | 218 | public $default_response_double_optin_success_message; |
219 | 219 | |
220 | 220 | /** |
221 | - * The default success message for already subscribed users re-subscribing |
|
222 | - * |
|
223 | - * @since 6.3.0 |
|
224 | - * @access public |
|
225 | - * @var string | $existing_subscriber_profile_update_message |
|
226 | - */ |
|
221 | + * The default success message for already subscribed users re-subscribing |
|
222 | + * |
|
223 | + * @since 6.3.0 |
|
224 | + * @access public |
|
225 | + * @var string | $existing_subscriber_profile_update_message |
|
226 | + */ |
|
227 | 227 | public $existing_subscriber_profile_update_message; |
228 | 228 | |
229 | 229 | /** |
230 | - * The construct function - sets all of our hardcoded variables |
|
231 | - * |
|
232 | - * @param bool | $is_ajax | Flag signifying whether this submission request is coming from an AJAX response or basic form submission |
|
233 | - */ |
|
230 | + * The construct function - sets all of our hardcoded variables |
|
231 | + * |
|
232 | + * @param bool | $is_ajax | Flag signifying whether this submission request is coming from an AJAX response or basic form submission |
|
233 | + */ |
|
234 | 234 | public function __construct( $is_ajax ) { |
235 | 235 | |
236 | 236 | // Set up our variables |
@@ -268,45 +268,45 @@ discard block |
||
268 | 268 | /**** Setters for our Form Variables ****/ |
269 | 269 | |
270 | 270 | /** |
271 | - * Set the form ID class property |
|
272 | - * |
|
273 | - * @since 6.3.0 |
|
274 | - * |
|
275 | - * @param int | $form_id | ID of the corresponding YIKES MailChimp form |
|
276 | - */ |
|
271 | + * Set the form ID class property |
|
272 | + * |
|
273 | + * @since 6.3.0 |
|
274 | + * |
|
275 | + * @param int | $form_id | ID of the corresponding YIKES MailChimp form |
|
276 | + */ |
|
277 | 277 | public function set_form_id( $form_id ) { |
278 | 278 | $this->form_id = $form_id; |
279 | 279 | } |
280 | 280 | |
281 | 281 | /** |
282 | - * Set the list ID class property |
|
283 | - * |
|
284 | - * @since 6.3.0 |
|
285 | - * |
|
286 | - * @param int | $list_id | ID of the corresponding MailChimp list |
|
287 | - */ |
|
282 | + * Set the list ID class property |
|
283 | + * |
|
284 | + * @since 6.3.0 |
|
285 | + * |
|
286 | + * @param int | $list_id | ID of the corresponding MailChimp list |
|
287 | + */ |
|
288 | 288 | public function set_list_id( $list_id ) { |
289 | 289 | $this->list_id = $list_id; |
290 | 290 | } |
291 | 291 | |
292 | 292 | /** |
293 | - * Set the email class property |
|
294 | - * |
|
295 | - * @since 6.3.0 |
|
296 | - * |
|
297 | - * @param string | $sanitized_email | The sanitized email |
|
298 | - */ |
|
293 | + * Set the email class property |
|
294 | + * |
|
295 | + * @since 6.3.0 |
|
296 | + * |
|
297 | + * @param string | $sanitized_email | The sanitized email |
|
298 | + */ |
|
299 | 299 | public function set_email( $sanitized_email ) { |
300 | 300 | $this->email = $sanitized_email; |
301 | 301 | } |
302 | 302 | |
303 | 303 | /** |
304 | - * Set the $error_messages class property |
|
305 | - * |
|
306 | - * @since 6.3.0 |
|
307 | - * |
|
308 | - * @param array | $error_messages | The array of user-defined error messages for this form |
|
309 | - */ |
|
304 | + * Set the $error_messages class property |
|
305 | + * |
|
306 | + * @since 6.3.0 |
|
307 | + * |
|
308 | + * @param array | $error_messages | The array of user-defined error messages for this form |
|
309 | + */ |
|
310 | 310 | public function set_error_messages( $error_messages ) { |
311 | 311 | $this->error_messages = $error_messages; |
312 | 312 | } |
@@ -315,24 +315,24 @@ discard block |
||
315 | 315 | /**** Simple Return Functions ****/ |
316 | 316 | |
317 | 317 | /** |
318 | - * Return a sanitized email |
|
319 | - * |
|
320 | - * @since 6.3.0 |
|
321 | - * |
|
322 | - * @param string | $email | The user's email |
|
323 | - * @return string| $email | The user's email, lowercased and sanitized |
|
324 | - */ |
|
318 | + * Return a sanitized email |
|
319 | + * |
|
320 | + * @since 6.3.0 |
|
321 | + * |
|
322 | + * @param string | $email | The user's email |
|
323 | + * @return string| $email | The user's email, lowercased and sanitized |
|
324 | + */ |
|
325 | 325 | public function get_sanitized_email( $email ) { |
326 | 326 | return sanitize_email( strtolower( $email ) ); |
327 | 327 | } |
328 | 328 | |
329 | 329 | /** |
330 | - * Return the class property $skipped_form_fields |
|
331 | - * |
|
332 | - * @since 6.3.0 |
|
333 | - * |
|
334 | - * @return array | $skipped_form_fields |
|
335 | - */ |
|
330 | + * Return the class property $skipped_form_fields |
|
331 | + * |
|
332 | + * @since 6.3.0 |
|
333 | + * |
|
334 | + * @return array | $skipped_form_fields |
|
335 | + */ |
|
336 | 336 | protected function get_skipped_merge_tags() { |
337 | 337 | return $this->skipped_form_fields; |
338 | 338 | } |
@@ -341,14 +341,14 @@ discard block |
||
341 | 341 | /**** Collection of functions handling the incoming form and interest group data ****/ |
342 | 342 | |
343 | 343 | /** |
344 | - * Loop through form data to sanitize, format, filter, and return. |
|
345 | - * |
|
346 | - * @since 6.3.0 |
|
347 | - * |
|
348 | - * @param array | $data | The array of user-submitted form values |
|
349 | - * @param array | $form_fields | The array of form field definitions for this YIKES MailChimp form |
|
350 | - * @return array| $merge_variables| The array of sanitized and formatted form values |
|
351 | - */ |
|
344 | + * Loop through form data to sanitize, format, filter, and return. |
|
345 | + * |
|
346 | + * @since 6.3.0 |
|
347 | + * |
|
348 | + * @param array | $data | The array of user-submitted form values |
|
349 | + * @param array | $form_fields | The array of form field definitions for this YIKES MailChimp form |
|
350 | + * @return array| $merge_variables| The array of sanitized and formatted form values |
|
351 | + */ |
|
352 | 352 | public function get_submitted_merge_values( $data, $form_fields ) { |
353 | 353 | |
354 | 354 | // Array to return |
@@ -386,13 +386,13 @@ discard block |
||
386 | 386 | } |
387 | 387 | |
388 | 388 | /** |
389 | - * yikes-mailchimp-filter-before-submission || yikes-mailchimp-filter-before-submission-{$form_id} |
|
390 | - * |
|
391 | - * Catch the merge variables before they get sent over to MailChimp |
|
392 | - * @since 6.0.0 |
|
393 | - * |
|
394 | - * @param array | $merge_variables | The user submitted form data |
|
395 | - */ |
|
389 | + * yikes-mailchimp-filter-before-submission || yikes-mailchimp-filter-before-submission-{$form_id} |
|
390 | + * |
|
391 | + * Catch the merge variables before they get sent over to MailChimp |
|
392 | + * @since 6.0.0 |
|
393 | + * |
|
394 | + * @param array | $merge_variables | The user submitted form data |
|
395 | + */ |
|
396 | 396 | $merge_variables = apply_filters( 'yikes-mailchimp-filter-before-submission', $merge_variables ); |
397 | 397 | $merge_variables = apply_filters( "yikes-mailchimp-filter-before-submission-{$this->form_id}", $merge_variables ); |
398 | 398 | |
@@ -400,14 +400,14 @@ discard block |
||
400 | 400 | } |
401 | 401 | |
402 | 402 | /** |
403 | - * Sanitize form values and return them |
|
404 | - * |
|
405 | - * @since 6.3.0 |
|
406 | - * |
|
407 | - * @param string | $key | The MERGE/Field-name for this value |
|
408 | - * @param mixed | $value | The form value - this could be an array or a string |
|
409 | - * @return mixed | $sanitized | The $value sanitized |
|
410 | - */ |
|
403 | + * Sanitize form values and return them |
|
404 | + * |
|
405 | + * @since 6.3.0 |
|
406 | + * |
|
407 | + * @param string | $key | The MERGE/Field-name for this value |
|
408 | + * @param mixed | $value | The form value - this could be an array or a string |
|
409 | + * @return mixed | $sanitized | The $value sanitized |
|
410 | + */ |
|
411 | 411 | protected function sanitize_form_values( $key, $value ) { |
412 | 412 | if ( is_scalar( $value ) ) { |
413 | 413 | $sanitized = sanitize_text_field( $value ); |
@@ -421,14 +421,14 @@ discard block |
||
421 | 421 | } |
422 | 422 | |
423 | 423 | /** |
424 | - * Check a date field's date format and pass it along to the appropriate function |
|
425 | - * |
|
426 | - * @since 6.3.0 |
|
427 | - * |
|
428 | - * @param string | $date | The unformatted date value |
|
429 | - * @param string | $date_format | The date format |
|
430 | - * @return string| $date | The date formatted according to the $date_format |
|
431 | - */ |
|
424 | + * Check a date field's date format and pass it along to the appropriate function |
|
425 | + * |
|
426 | + * @since 6.3.0 |
|
427 | + * |
|
428 | + * @param string | $date | The unformatted date value |
|
429 | + * @param string | $date_format | The date format |
|
430 | + * @return string| $date | The date formatted according to the $date_format |
|
431 | + */ |
|
432 | 432 | protected function handle_date_format_merge_values( $date, $date_format ) { |
433 | 433 | // Check if EU date format (for dates: 'DD/MM/YYYY', for birthdays: 'DD/MM') |
434 | 434 | if ( 'DD/MM/YYYY' === $date_format ) { |
@@ -441,13 +441,13 @@ discard block |
||
441 | 441 | } |
442 | 442 | |
443 | 443 | /** |
444 | - * Format a date field whose date format is dd/mm/yyyy |
|
445 | - * |
|
446 | - * @since 6.3.0 |
|
447 | - * |
|
448 | - * @param string | $date | A date in the format dd/mm/yyyy |
|
449 | - * @return string| $date | A date in the format mm/dd/yyyy |
|
450 | - */ |
|
444 | + * Format a date field whose date format is dd/mm/yyyy |
|
445 | + * |
|
446 | + * @since 6.3.0 |
|
447 | + * |
|
448 | + * @param string | $date | A date in the format dd/mm/yyyy |
|
449 | + * @return string| $date | A date in the format mm/dd/yyyy |
|
450 | + */ |
|
451 | 451 | protected function handle_dd_mm_yyyy_date( $date ) { |
452 | 452 | |
453 | 453 | // MailChimp wants the dates as 'MM/DD/YYYY' regardless of user-specified format, so convert |
@@ -466,13 +466,13 @@ discard block |
||
466 | 466 | } |
467 | 467 | |
468 | 468 | /** |
469 | - * Format a birthday field whose date format is dd/mm |
|
470 | - * |
|
471 | - * @since 6.3.0 |
|
472 | - * |
|
473 | - * @param string | $birthday | A date in the format dd/mm |
|
474 | - * @return string| $birthday | A date in the format mm/dd |
|
475 | - */ |
|
469 | + * Format a birthday field whose date format is dd/mm |
|
470 | + * |
|
471 | + * @since 6.3.0 |
|
472 | + * |
|
473 | + * @param string | $birthday | A date in the format dd/mm |
|
474 | + * @return string| $birthday | A date in the format mm/dd |
|
475 | + */ |
|
476 | 476 | protected function handle_dd_mm_birthday( $birthday ) { |
477 | 477 | |
478 | 478 | // MailChimp wants the birthdays as 'MM/DD' regardless of user-specified format, so convert |
@@ -492,14 +492,14 @@ discard block |
||
492 | 492 | |
493 | 493 | |
494 | 494 | /** |
495 | - * Create an array of available interest groups based on the $replace_interests flag |
|
496 | - * |
|
497 | - * @since 6.3.0 |
|
498 | - * |
|
499 | - * @param bool | $replace_interests| True if we're replacing interest groups, false if updating interest groups |
|
500 | - * @param class | $list_class | Class for interacting with the current list |
|
501 | - * @return array | $groups | Array of interest groups |
|
502 | - */ |
|
495 | + * Create an array of available interest groups based on the $replace_interests flag |
|
496 | + * |
|
497 | + * @since 6.3.0 |
|
498 | + * |
|
499 | + * @param bool | $replace_interests| True if we're replacing interest groups, false if updating interest groups |
|
500 | + * @param class | $list_class | Class for interacting with the current list |
|
501 | + * @return array | $groups | Array of interest groups |
|
502 | + */ |
|
503 | 503 | public function get_default_interest_groups( $replace_interests, $list_class ) { |
504 | 504 | |
505 | 505 | // If $replace_interests flag is true then loop through interest groups and set them all to false to start. |
@@ -533,15 +533,15 @@ discard block |
||
533 | 533 | |
534 | 534 | |
535 | 535 | /** |
536 | - * Loop through the interest group form data to sanitize, format, filter, and return. |
|
537 | - * |
|
538 | - * @since 6.3.0 |
|
539 | - * |
|
540 | - * @param array | $data | The array of user-submitted form values |
|
541 | - * @param array | $form_fields | The array of form field definitions for this YIKES MailChimp form |
|
542 | - * @param array | $groups | The array of interest groups created by `get_default_interest_groups()` |
|
543 | - * @return array| $groups | The array of sanitized and formatted form values |
|
544 | - */ |
|
536 | + * Loop through the interest group form data to sanitize, format, filter, and return. |
|
537 | + * |
|
538 | + * @since 6.3.0 |
|
539 | + * |
|
540 | + * @param array | $data | The array of user-submitted form values |
|
541 | + * @param array | $form_fields | The array of form field definitions for this YIKES MailChimp form |
|
542 | + * @param array | $groups | The array of interest groups created by `get_default_interest_groups()` |
|
543 | + * @return array| $groups | The array of sanitized and formatted form values |
|
544 | + */ |
|
545 | 545 | public function get_submitted_interest_groups( $data, $form_fields, $groups ) { |
546 | 546 | |
547 | 547 | // loop to push variables to our array |
@@ -570,13 +570,13 @@ discard block |
||
570 | 570 | } |
571 | 571 | |
572 | 572 | /** |
573 | - * yikes-mailchimp-filter-groups-before-submission |
|
574 | - * |
|
575 | - * Catch the interest groups before they get sent over to MailChimp |
|
576 | - * @param array | $groups | User submitted interest group data |
|
577 | - * @optional int| $form_id| the ID of the form to filter |
|
578 | - * @since 6.3.0 |
|
579 | - */ |
|
573 | + * yikes-mailchimp-filter-groups-before-submission |
|
574 | + * |
|
575 | + * Catch the interest groups before they get sent over to MailChimp |
|
576 | + * @param array | $groups | User submitted interest group data |
|
577 | + * @optional int| $form_id| the ID of the form to filter |
|
578 | + * @since 6.3.0 |
|
579 | + */ |
|
580 | 580 | $groups = apply_filters( 'yikes-mailchimp-filter-groups-before-submission', $groups, $this->form_id ); |
581 | 581 | $groups = apply_filters( 'yikes-mailchimp-filter-groups-before-submission-{$this->form_id}', $groups, $this->form_id ); |
582 | 582 | |
@@ -587,17 +587,17 @@ discard block |
||
587 | 587 | /**** Functions to Handle Subscribe API Response ****/ |
588 | 588 | |
589 | 589 | /** |
590 | - * Handle the response to a successful subscribe request |
|
591 | - * |
|
592 | - * @since 6.3.0 |
|
593 | - * |
|
594 | - * @param array | $submission_settings | Array of the form's submission settings |
|
595 | - * @param array | $page_data | Array of the page data |
|
596 | - * @param array | $merge_variables | Array of the submitted form variables |
|
597 | - * @param array | $notifications | Literally don't know what this is yet. |
|
598 | - * @param array | $optin_settings | Array of the form's optin settings |
|
599 | - * @param bool | $new_subscriber | True if a new subscriber, false if an existing one |
|
600 | - */ |
|
590 | + * Handle the response to a successful subscribe request |
|
591 | + * |
|
592 | + * @since 6.3.0 |
|
593 | + * |
|
594 | + * @param array | $submission_settings | Array of the form's submission settings |
|
595 | + * @param array | $page_data | Array of the page data |
|
596 | + * @param array | $merge_variables | Array of the submitted form variables |
|
597 | + * @param array | $notifications | Literally don't know what this is yet. |
|
598 | + * @param array | $optin_settings | Array of the form's optin settings |
|
599 | + * @param bool | $new_subscriber | True if a new subscriber, false if an existing one |
|
600 | + */ |
|
601 | 601 | public function handle_submission_response_success( $submission_settings, $page_data, $merge_variables, $notifications, $optin_settings, $new_subscriber ) { |
602 | 602 | |
603 | 603 | // Check if we should redirect, and collect the redirect info in an array |
@@ -606,27 +606,27 @@ discard block |
||
606 | 606 | // Fire off our actions |
607 | 607 | |
608 | 608 | /** |
609 | - * yikes-mailchimp-after-submission || yikes-mailchimp-after-submission-{$form_id} |
|
610 | - * |
|
611 | - * Catch the merge variables after they've been sent over to MailChimp |
|
612 | - * @since 6.0.0 |
|
613 | - * |
|
614 | - * @param array | $merge_variables | The array of user submitted form data |
|
615 | - */ |
|
609 | + * yikes-mailchimp-after-submission || yikes-mailchimp-after-submission-{$form_id} |
|
610 | + * |
|
611 | + * Catch the merge variables after they've been sent over to MailChimp |
|
612 | + * @since 6.0.0 |
|
613 | + * |
|
614 | + * @param array | $merge_variables | The array of user submitted form data |
|
615 | + */ |
|
616 | 616 | do_action( 'yikes-mailchimp-after-submission', $merge_variables, $this->form_id ); |
617 | 617 | do_action( "yikes-mailchimp-after-submission-{$this->form_id}", $merge_variables, $this->form_id ); |
618 | 618 | |
619 | 619 | /** |
620 | - * yikes-mailchimp-form-submission || yikes-mailchimp-form-submission-{$form_id} |
|
621 | - * |
|
622 | - * Catch our notifications and other form data |
|
623 | - * |
|
624 | - * @param string | $email | The user's email |
|
625 | - * @param array | $merge_variables | The array of user submitted form data |
|
626 | - * @param string | $form_id | The form ID |
|
627 | - * @param array | $notifications | Array of notification messages |
|
628 | - * |
|
629 | - */ |
|
620 | + * yikes-mailchimp-form-submission || yikes-mailchimp-form-submission-{$form_id} |
|
621 | + * |
|
622 | + * Catch our notifications and other form data |
|
623 | + * |
|
624 | + * @param string | $email | The user's email |
|
625 | + * @param array | $merge_variables | The array of user submitted form data |
|
626 | + * @param string | $form_id | The form ID |
|
627 | + * @param array | $notifications | Array of notification messages |
|
628 | + * |
|
629 | + */ |
|
630 | 630 | do_action( 'yikes-mailchimp-form-submission', $this->email, $merge_variables, $this->form_id, $notifications ); |
631 | 631 | do_action( "yikes-mailchimp-form-submission-{$this->form_id}", $this->email, $merge_variables, $this->form_id, $notifications ); |
632 | 632 | |
@@ -648,15 +648,15 @@ discard block |
||
648 | 648 | $default_response = ( $new_subscriber === false ) ? $this->check_for_user_defined_response_message( 'success-resubscribed', $this->existing_subscriber_profile_update_message ) : $default_response; |
649 | 649 | |
650 | 650 | /** |
651 | - * yikes-mailchimp-success-response |
|
652 | - * |
|
653 | - * Filter the success message displayed to the user |
|
654 | - * |
|
655 | - * @param string | $default_response | The response message that will be shown to the user if unchanged (see above for logic) |
|
656 | - * @param string | $form_id | The form ID |
|
657 | - * @param array | $merge_variables | The array of user submitted form data |
|
658 | - * |
|
659 | - */ |
|
651 | + * yikes-mailchimp-success-response |
|
652 | + * |
|
653 | + * Filter the success message displayed to the user |
|
654 | + * |
|
655 | + * @param string | $default_response | The response message that will be shown to the user if unchanged (see above for logic) |
|
656 | + * @param string | $form_id | The form ID |
|
657 | + * @param array | $merge_variables | The array of user submitted form data |
|
658 | + * |
|
659 | + */ |
|
660 | 660 | $response_message = apply_filters( 'yikes-mailchimp-success-response', $default_response, $this->form_id, $merge_variables ); |
661 | 661 | |
662 | 662 | // Construct our success array variables |
@@ -675,13 +675,13 @@ discard block |
||
675 | 675 | } |
676 | 676 | |
677 | 677 | /** |
678 | - * Handle an unsuccessful/error subscribe request |
|
679 | - * |
|
680 | - * @since 6.3.0 |
|
681 | - * |
|
682 | - * @param object | $subscribe_response | The response from the API |
|
683 | - * @param array | $form_fields | The array of form field definitions for this YIKES MailChimp form |
|
684 | - */ |
|
678 | + * Handle an unsuccessful/error subscribe request |
|
679 | + * |
|
680 | + * @since 6.3.0 |
|
681 | + * |
|
682 | + * @param object | $subscribe_response | The response from the API |
|
683 | + * @param array | $form_fields | The array of form field definitions for this YIKES MailChimp form |
|
684 | + */ |
|
685 | 685 | public function handle_submission_response_error( $subscribe_response, $form_fields ) { |
686 | 686 | |
687 | 687 | // Get the error data |
@@ -723,13 +723,13 @@ discard block |
||
723 | 723 | // Note: All of these functions return `return $this->yikes_fail()`. Check function for more info. |
724 | 724 | |
725 | 725 | /** |
726 | - * Check if the submitted form data is missing any required fields |
|
727 | - * |
|
728 | - * @since 6.3.0 |
|
729 | - * |
|
730 | - * @param array | $data | The array of user-submitted form values |
|
731 | - * @param array | $form_fields | The array of form field definitions for this YIKES MailChimp form |
|
732 | - */ |
|
726 | + * Check if the submitted form data is missing any required fields |
|
727 | + * |
|
728 | + * @since 6.3.0 |
|
729 | + * |
|
730 | + * @param array | $data | The array of user-submitted form values |
|
731 | + * @param array | $form_fields | The array of form field definitions for this YIKES MailChimp form |
|
732 | + */ |
|
733 | 733 | public function check_for_required_form_fields( $data, $form_fields ) { |
734 | 734 | |
735 | 735 | // Set up our defaults |
@@ -754,15 +754,15 @@ discard block |
||
754 | 754 | foreach( $value as $field => $val ) { |
755 | 755 | |
756 | 756 | /** |
757 | - * 'yikes-mailchimp-ignore-required-array-field' |
|
758 | - * |
|
759 | - * Filter the default array of fields we're ignoring. As of now, this is only for address fields because no other field is an array. |
|
760 | - * |
|
761 | - * @param array | Array of fields to ignore. Key of the array should be the field name. |
|
762 | - * @param int | $form_id |
|
763 | - * |
|
764 | - * @return Array of fields to ignore. |
|
765 | - */ |
|
757 | + * 'yikes-mailchimp-ignore-required-array-field' |
|
758 | + * |
|
759 | + * Filter the default array of fields we're ignoring. As of now, this is only for address fields because no other field is an array. |
|
760 | + * |
|
761 | + * @param array | Array of fields to ignore. Key of the array should be the field name. |
|
762 | + * @param int | $form_id |
|
763 | + * |
|
764 | + * @return Array of fields to ignore. |
|
765 | + */ |
|
766 | 766 | $ignored_fields = apply_filters( 'yikes-mailchimp-ignore-required-array-field', array( 'addr2' => true ), $this->form_id ); |
767 | 767 | |
768 | 768 | if ( empty( $val ) && ! isset( $ignored_fields[ $field ] ) ) { |
@@ -793,14 +793,14 @@ discard block |
||
793 | 793 | ); |
794 | 794 | |
795 | 795 | /** |
796 | - * yikes-mailchimp-required-form-field-missing |
|
797 | - * |
|
798 | - * Alter the response message shown to the user for missing required form fields |
|
799 | - * |
|
800 | - * @param string | $handle_empty_required_field_message | The default message displayed to the user |
|
801 | - * @param int | $form_id | The ID of the form |
|
802 | - * @param array | $missing_fields | Array of the missing required fields |
|
803 | - */ |
|
796 | + * yikes-mailchimp-required-form-field-missing |
|
797 | + * |
|
798 | + * Alter the response message shown to the user for missing required form fields |
|
799 | + * |
|
800 | + * @param string | $handle_empty_required_field_message | The default message displayed to the user |
|
801 | + * @param int | $form_id | The ID of the form |
|
802 | + * @param array | $missing_fields | Array of the missing required fields |
|
803 | + */ |
|
804 | 804 | $default_response = apply_filters( 'yikes-mailchimp-required-form-field-missing', $this->handle_empty_required_field_message, $this->form_id, $missing_fields ); |
805 | 805 | |
806 | 806 | // If we've found a missing field, return the array of field data |
@@ -809,13 +809,13 @@ discard block |
||
809 | 809 | } |
810 | 810 | |
811 | 811 | /** |
812 | - * Check if the submitted form interest group data is missing any required fields |
|
813 | - * |
|
814 | - * @since 6.3.0 |
|
815 | - * |
|
816 | - * @param array | $data | The array of user-submitted form values |
|
817 | - * @param array | $form_fields | The array of form field definitions for this YIKES MailChimp form |
|
818 | - */ |
|
812 | + * Check if the submitted form interest group data is missing any required fields |
|
813 | + * |
|
814 | + * @since 6.3.0 |
|
815 | + * |
|
816 | + * @param array | $data | The array of user-submitted form values |
|
817 | + * @param array | $form_fields | The array of form field definitions for this YIKES MailChimp form |
|
818 | + */ |
|
819 | 819 | public function check_for_required_interest_groups( $data, $form_fields ) { |
820 | 820 | |
821 | 821 | // Set up our defaults |
@@ -849,14 +849,14 @@ discard block |
||
849 | 849 | ); |
850 | 850 | |
851 | 851 | /** |
852 | - * yikes-mailchimp-required-interest-group-missing |
|
853 | - * |
|
854 | - * Alter the response message shown to the user for missing required form fields |
|
855 | - * |
|
856 | - * @param string | $handle_empty_required_interest_group_message | The default message displayed to the user |
|
857 | - * @param int | $form_id | The ID of the form |
|
858 | - * @param array | $missing_fields | Array of the missing required fields |
|
859 | - */ |
|
852 | + * yikes-mailchimp-required-interest-group-missing |
|
853 | + * |
|
854 | + * Alter the response message shown to the user for missing required form fields |
|
855 | + * |
|
856 | + * @param string | $handle_empty_required_interest_group_message | The default message displayed to the user |
|
857 | + * @param int | $form_id | The ID of the form |
|
858 | + * @param array | $missing_fields | Array of the missing required fields |
|
859 | + */ |
|
860 | 860 | $default_response = apply_filters( 'yikes-mailchimp-required-interest-group-missing', $this->handle_empty_required_interest_group_message, $this->form_id, $missing_fields ); |
861 | 861 | |
862 | 862 | // If we find a required interest group with an empty value, send an error |
@@ -865,12 +865,12 @@ discard block |
||
865 | 865 | } |
866 | 866 | |
867 | 867 | /** |
868 | - * Handle the reCAPTCHA |
|
869 | - * |
|
870 | - * @since 6.3.0 |
|
871 | - * |
|
872 | - * @param string | $recaptcha_response | The form value of the recaptcha field |
|
873 | - */ |
|
868 | + * Handle the reCAPTCHA |
|
869 | + * |
|
870 | + * @since 6.3.0 |
|
871 | + * |
|
872 | + * @param string | $recaptcha_response | The form value of the recaptcha field |
|
873 | + */ |
|
874 | 874 | public function handle_recaptcha( $recaptcha_response ) { |
875 | 875 | |
876 | 876 | // Before we the hit the API, let's check that we actually got a response. |
@@ -878,11 +878,11 @@ discard block |
||
878 | 878 | if ( empty( $recaptcha_response ) ) { |
879 | 879 | |
880 | 880 | /** |
881 | - * yikes-mailchimp-recaptcha-required-error |
|
882 | - * |
|
883 | - * Catch the recaptcha errors before they're returned to the user |
|
884 | - * @param string | $recaptcha_errors | A string of recaptcha errors separated by a space |
|
885 | - */ |
|
881 | + * yikes-mailchimp-recaptcha-required-error |
|
882 | + * |
|
883 | + * Catch the recaptcha errors before they're returned to the user |
|
884 | + * @param string | $recaptcha_errors | A string of recaptcha errors separated by a space |
|
885 | + */ |
|
886 | 886 | $response = apply_filters( 'yikes-mailchimp-recaptcha-required-error', $this->handle_non_filled_recaptcha_message_message, $this->form_id ); |
887 | 887 | return $this->yikes_fail( $hide = 0, $error = 1, $response, array(), $return_response_non_ajax = true ); |
888 | 888 | } |
@@ -915,40 +915,40 @@ discard block |
||
915 | 915 | } |
916 | 916 | |
917 | 917 | /** |
918 | - * yikes-mailchimp-recaptcha-required-error |
|
919 | - * |
|
920 | - * Catch the recaptcha errors before they're returned to the user |
|
921 | - * @param string | $recaptcha_errors | A string of recaptcha errors separated by a space |
|
922 | - */ |
|
918 | + * yikes-mailchimp-recaptcha-required-error |
|
919 | + * |
|
920 | + * Catch the recaptcha errors before they're returned to the user |
|
921 | + * @param string | $recaptcha_errors | A string of recaptcha errors separated by a space |
|
922 | + */ |
|
923 | 923 | $response = apply_filters( 'yikes-mailchimp-recaptcha-required-error', implode( ' ', $recaptcha_errors ), $this->form_id ); |
924 | 924 | return $this->yikes_fail( $hide = 0, $error = 1, $response, array(), $return_response_non_ajax = true ); |
925 | 925 | } |
926 | 926 | } |
927 | 927 | |
928 | 928 | /** |
929 | - * Handle the nonce field |
|
930 | - * |
|
931 | - * @since 6.3.0 |
|
932 | - * |
|
933 | - * @param string | $nonce_value | The form value of the nonce |
|
934 | - * @param string | $nonce_name | The name of the nonce |
|
935 | - */ |
|
929 | + * Handle the nonce field |
|
930 | + * |
|
931 | + * @since 6.3.0 |
|
932 | + * |
|
933 | + * @param string | $nonce_value | The form value of the nonce |
|
934 | + * @param string | $nonce_name | The name of the nonce |
|
935 | + */ |
|
936 | 936 | public function handle_nonce( $nonce_value, $nonce_name ) { |
937 | 937 | |
938 | 938 | // First, check our option - this is set in the general settings page |
939 | 939 | if ( get_option( 'yikes-mailchimp-use-nonce' ) === '1' ) { |
940 | 940 | |
941 | 941 | /** |
942 | - * yikes-mailchimp-use-nonce-verification |
|
943 | - * |
|
944 | - * Decide if we're going to check the nonce value. |
|
945 | - * The reason we filter this is that some users are experiencing nonce issues repeatedly. |
|
946 | - * The default will always be to use the nonce. |
|
947 | - * |
|
948 | - * @param int | $form_id | The form id |
|
949 | - * |
|
950 | - * @return bool | True if we should check the nonce |
|
951 | - */ |
|
942 | + * yikes-mailchimp-use-nonce-verification |
|
943 | + * |
|
944 | + * Decide if we're going to check the nonce value. |
|
945 | + * The reason we filter this is that some users are experiencing nonce issues repeatedly. |
|
946 | + * The default will always be to use the nonce. |
|
947 | + * |
|
948 | + * @param int | $form_id | The form id |
|
949 | + * |
|
950 | + * @return bool | True if we should check the nonce |
|
951 | + */ |
|
952 | 952 | $use_nonce = apply_filters( 'yikes-mailchimp-use-nonce-verification', true, $this->form_id ); |
953 | 953 | |
954 | 954 | // We let the filter override the option because the filter is on a per-form basis |
@@ -961,24 +961,24 @@ discard block |
||
961 | 961 | } |
962 | 962 | |
963 | 963 | /** |
964 | - * Handle a merge_variables error |
|
965 | - * |
|
966 | - * @since 6.3.0 |
|
967 | - * |
|
968 | - * @param int | $error | Int $error = 1 if an error |
|
969 | - * @param string | $message | The message shown to the user |
|
970 | - */ |
|
964 | + * Handle a merge_variables error |
|
965 | + * |
|
966 | + * @since 6.3.0 |
|
967 | + * |
|
968 | + * @param int | $error | Int $error = 1 if an error |
|
969 | + * @param string | $message | The message shown to the user |
|
970 | + */ |
|
971 | 971 | public function handle_merge_variables_error( $error, $message ) { |
972 | 972 | return $this->yikes_fail( $hide = 0, $error, $message, array(), $return_response_non_ajax = true ); |
973 | 973 | } |
974 | 974 | |
975 | 975 | /** |
976 | - * Handle an empty email field and return the corresponding error message |
|
977 | - * |
|
978 | - * @since 6.3.0 |
|
979 | - * |
|
980 | - * @param string | $email |
|
981 | - */ |
|
976 | + * Handle an empty email field and return the corresponding error message |
|
977 | + * |
|
978 | + * @since 6.3.0 |
|
979 | + * |
|
980 | + * @param string | $email |
|
981 | + */ |
|
982 | 982 | public function handle_empty_email( $email ) { |
983 | 983 | if ( empty( $email ) ) { |
984 | 984 | return $this->yikes_fail( $hide = 0, $error = 1, $this->handle_empty_email_message ); |
@@ -986,12 +986,12 @@ discard block |
||
986 | 986 | } |
987 | 987 | |
988 | 988 | /** |
989 | - * Check if the form is empty and return the corresponding error message |
|
990 | - * |
|
991 | - * @since 6.3.0 |
|
992 | - * |
|
993 | - * @param array | $form_data |
|
994 | - */ |
|
989 | + * Check if the form is empty and return the corresponding error message |
|
990 | + * |
|
991 | + * @since 6.3.0 |
|
992 | + * |
|
993 | + * @param array | $form_data |
|
994 | + */ |
|
995 | 995 | public function handle_empty_form( $form_data ) { |
996 | 996 | if ( empty( $form_data ) ) { |
997 | 997 | return $this->yikes_fail( $hide = 0, $error = 1, $this->handle_empty_form_message ); |
@@ -999,12 +999,12 @@ discard block |
||
999 | 999 | } |
1000 | 1000 | |
1001 | 1001 | /** |
1002 | - * Check if the honeypot is NOT empty and return the corresponding error message |
|
1003 | - * |
|
1004 | - * @since 6.3.0 |
|
1005 | - * |
|
1006 | - * @param bool | $honey_pot_filled | True if the honeypot was filled out |
|
1007 | - */ |
|
1002 | + * Check if the honeypot is NOT empty and return the corresponding error message |
|
1003 | + * |
|
1004 | + * @since 6.3.0 |
|
1005 | + * |
|
1006 | + * @param bool | $honey_pot_filled | True if the honeypot was filled out |
|
1007 | + */ |
|
1008 | 1008 | public function handle_non_empty_honeypot( $honey_pot_filled ) { |
1009 | 1009 | if ( $honey_pot_filled === true ) { |
1010 | 1010 | return $this->yikes_fail( $hide = 0, $error = 1, $this->handle_non_empty_honeypot_message ); |
@@ -1012,12 +1012,12 @@ discard block |
||
1012 | 1012 | } |
1013 | 1013 | |
1014 | 1014 | /** |
1015 | - * Loop through fields looking for null and return the corresponding error message |
|
1016 | - * |
|
1017 | - * @since 6.3.0 |
|
1018 | - * |
|
1019 | - * @param array | $fields_array | An array of fields to loop through and make sure they're not null |
|
1020 | - */ |
|
1015 | + * Loop through fields looking for null and return the corresponding error message |
|
1016 | + * |
|
1017 | + * @since 6.3.0 |
|
1018 | + * |
|
1019 | + * @param array | $fields_array | An array of fields to loop through and make sure they're not null |
|
1020 | + */ |
|
1021 | 1021 | public function handle_empty_fields_generic( $fields_array ) { |
1022 | 1022 | foreach( $fields_array as $field ) { |
1023 | 1023 | if ( $field === null ) { |
@@ -1027,12 +1027,12 @@ discard block |
||
1027 | 1027 | } |
1028 | 1028 | |
1029 | 1029 | /** |
1030 | - * Check if the list handler is empty and return the corresponding error message |
|
1031 | - * |
|
1032 | - * @since 6.3.0 |
|
1033 | - * |
|
1034 | - * @param class | $list_handler | A class that handles list functions |
|
1035 | - */ |
|
1030 | + * Check if the list handler is empty and return the corresponding error message |
|
1031 | + * |
|
1032 | + * @since 6.3.0 |
|
1033 | + * |
|
1034 | + * @param class | $list_handler | A class that handles list functions |
|
1035 | + */ |
|
1036 | 1036 | public function handle_empty_list_handler( $list_handler ) { |
1037 | 1037 | if ( empty( $list_handler ) ) { |
1038 | 1038 | return $this->yikes_fail( $hide = 0, $error = 1, $this->handle_empty_list_handler_message ); |
@@ -1040,12 +1040,12 @@ discard block |
||
1040 | 1040 | } |
1041 | 1041 | |
1042 | 1042 | /** |
1043 | - * Check if the form id is empty and return the corresponding error message |
|
1044 | - * |
|
1045 | - * @since 6.3.0 |
|
1046 | - * |
|
1047 | - * @param int | $form_id | The form ID |
|
1048 | - */ |
|
1043 | + * Check if the form id is empty and return the corresponding error message |
|
1044 | + * |
|
1045 | + * @since 6.3.0 |
|
1046 | + * |
|
1047 | + * @param int | $form_id | The form ID |
|
1048 | + */ |
|
1049 | 1049 | public function handle_empty_form_id( $form_id ) { |
1050 | 1050 | if ( empty( $form_id ) ) { |
1051 | 1051 | return $this->yikes_fail( $hide = 0, $error = 1, $this->handle_empty_form_id_message ); |
@@ -1053,10 +1053,10 @@ discard block |
||
1053 | 1053 | } |
1054 | 1054 | |
1055 | 1055 | /** |
1056 | - * Construct and filter the error message related to user's re-subscribing when it's not allowed |
|
1057 | - * |
|
1058 | - * @since 6.3.0 |
|
1059 | - */ |
|
1056 | + * Construct and filter the error message related to user's re-subscribing when it's not allowed |
|
1057 | + * |
|
1058 | + * @since 6.3.0 |
|
1059 | + */ |
|
1060 | 1060 | public function handle_disallowed_existing_user_update() { |
1061 | 1061 | |
1062 | 1062 | // Get the default response |
@@ -1069,10 +1069,10 @@ discard block |
||
1069 | 1069 | } |
1070 | 1070 | |
1071 | 1071 | /** |
1072 | - * Construct and filter the error message related to the profile link to update user's profile |
|
1073 | - * |
|
1074 | - * @since 6.3.0 |
|
1075 | - */ |
|
1072 | + * Construct and filter the error message related to the profile link to update user's profile |
|
1073 | + * |
|
1074 | + * @since 6.3.0 |
|
1075 | + */ |
|
1076 | 1076 | public function handle_updating_existing_user() { |
1077 | 1077 | |
1078 | 1078 | // Get the first half of the message |
@@ -1097,15 +1097,15 @@ discard block |
||
1097 | 1097 | /**** Helper Functions ****/ |
1098 | 1098 | |
1099 | 1099 | /** |
1100 | - * Check the user-defined $error_messages array for a message, filter it, and return it. These messages overwrite the defaults. |
|
1101 | - * |
|
1102 | - * @since 6.3.0 |
|
1103 | - * |
|
1104 | - * @param string | $slug | The type of message we're looking for |
|
1105 | - * @param string | $response_text| The default response message |
|
1106 | - * @param array | $data | An array of data that may be needed to construct the user's error message |
|
1107 | - * @return string| $response_text| The $response_text (after it's potentially been changed) |
|
1108 | - */ |
|
1100 | + * Check the user-defined $error_messages array for a message, filter it, and return it. These messages overwrite the defaults. |
|
1101 | + * |
|
1102 | + * @since 6.3.0 |
|
1103 | + * |
|
1104 | + * @param string | $slug | The type of message we're looking for |
|
1105 | + * @param string | $response_text| The default response message |
|
1106 | + * @param array | $data | An array of data that may be needed to construct the user's error message |
|
1107 | + * @return string| $response_text| The $response_text (after it's potentially been changed) |
|
1108 | + */ |
|
1109 | 1109 | protected function check_for_user_defined_response_message( $slug, $response_text, $data = false ) { |
1110 | 1110 | |
1111 | 1111 | switch( $slug ) { |
@@ -1119,13 +1119,13 @@ discard block |
||
1119 | 1119 | } |
1120 | 1120 | |
1121 | 1121 | /** |
1122 | - * yikes-easy-mailchimp-user-already-subscribed-text |
|
1123 | - * |
|
1124 | - * Catch the message for user's already subscrbed before we show it to the user |
|
1125 | - * @param string | $message | The response message |
|
1126 | - * @param int | $form_id | The form id |
|
1127 | - * @param string | $email | The user's email |
|
1128 | - */ |
|
1122 | + * yikes-easy-mailchimp-user-already-subscribed-text |
|
1123 | + * |
|
1124 | + * Catch the message for user's already subscrbed before we show it to the user |
|
1125 | + * @param string | $message | The response message |
|
1126 | + * @param int | $form_id | The form id |
|
1127 | + * @param string | $email | The user's email |
|
1128 | + */ |
|
1129 | 1129 | $response_text = apply_filters( 'yikes-mailchimp-user-already-subscribed-text', $response_text, $this->form_id, $this->email ); |
1130 | 1130 | |
1131 | 1131 | return $response_text; |
@@ -1144,13 +1144,13 @@ discard block |
||
1144 | 1144 | } |
1145 | 1145 | |
1146 | 1146 | /** |
1147 | - * yikes-easy-mailchimp-user-already-subscribed-link-text |
|
1148 | - * |
|
1149 | - * Catch the message for user's already subscrbed link text before we show it to the user |
|
1150 | - * |
|
1151 | - * @param string | $response_text | The response message that will be shown to the user |
|
1152 | - * @param string | $form_id | The form ID |
|
1153 | - */ |
|
1147 | + * yikes-easy-mailchimp-user-already-subscribed-link-text |
|
1148 | + * |
|
1149 | + * Catch the message for user's already subscrbed link text before we show it to the user |
|
1150 | + * |
|
1151 | + * @param string | $response_text | The response message that will be shown to the user |
|
1152 | + * @param string | $form_id | The form ID |
|
1153 | + */ |
|
1154 | 1154 | $response_text = apply_filters( 'yikes-mailchimp-user-already-subscribed-link-text', $response_text, $this->form_id ); |
1155 | 1155 | |
1156 | 1156 | return $response_text; |
@@ -1164,14 +1164,14 @@ discard block |
||
1164 | 1164 | } |
1165 | 1165 | |
1166 | 1166 | /** |
1167 | - * yikes-mailchimp-success-double-optin-response |
|
1168 | - * |
|
1169 | - * Filter the success message displayed to the user |
|
1170 | - * |
|
1171 | - * @param string | $response_text | The response message that will be shown to the user |
|
1172 | - * @param string | $form_id | The form ID |
|
1173 | - * |
|
1174 | - */ |
|
1167 | + * yikes-mailchimp-success-double-optin-response |
|
1168 | + * |
|
1169 | + * Filter the success message displayed to the user |
|
1170 | + * |
|
1171 | + * @param string | $response_text | The response message that will be shown to the user |
|
1172 | + * @param string | $form_id | The form ID |
|
1173 | + * |
|
1174 | + */ |
|
1175 | 1175 | $response_text = apply_filters( 'yikes-mailchimp-success-double-optin-response', $response_text, $this->form_id ); |
1176 | 1176 | |
1177 | 1177 | return $response_text; |
@@ -1184,14 +1184,14 @@ discard block |
||
1184 | 1184 | } |
1185 | 1185 | |
1186 | 1186 | /** |
1187 | - * yikes-mailchimp-success-single-optin-response |
|
1188 | - * |
|
1189 | - * Filter the success message displayed to the user |
|
1190 | - * |
|
1191 | - * @param string | $response_text | The response message that will be shown to the user |
|
1192 | - * @param string | $form_id | The form ID |
|
1193 | - * |
|
1194 | - */ |
|
1187 | + * yikes-mailchimp-success-single-optin-response |
|
1188 | + * |
|
1189 | + * Filter the success message displayed to the user |
|
1190 | + * |
|
1191 | + * @param string | $response_text | The response message that will be shown to the user |
|
1192 | + * @param string | $form_id | The form ID |
|
1193 | + * |
|
1194 | + */ |
|
1195 | 1195 | $response_text = apply_filters( 'yikes-mailchimp-success-single-optin-response', $response_text, $this->form_id ); |
1196 | 1196 | |
1197 | 1197 | return $response_text; |
@@ -1204,14 +1204,14 @@ discard block |
||
1204 | 1204 | } |
1205 | 1205 | |
1206 | 1206 | /** |
1207 | - * yikes-mailchimp-success-resubscribed-response |
|
1208 | - * |
|
1209 | - * Filter the success message displayed to the user |
|
1210 | - * |
|
1211 | - * @param string | $response_text | The response message that will be shown to the user |
|
1212 | - * @param string | $form_id | The form ID |
|
1213 | - * |
|
1214 | - */ |
|
1207 | + * yikes-mailchimp-success-resubscribed-response |
|
1208 | + * |
|
1209 | + * Filter the success message displayed to the user |
|
1210 | + * |
|
1211 | + * @param string | $response_text | The response message that will be shown to the user |
|
1212 | + * @param string | $form_id | The form ID |
|
1213 | + * |
|
1214 | + */ |
|
1215 | 1215 | $response_text = apply_filters( 'yikes-mailchimp-success-resubscribed-response', $response_text, $this->form_id ); |
1216 | 1216 | |
1217 | 1217 | return $response_text; |
@@ -1227,16 +1227,16 @@ discard block |
||
1227 | 1227 | } |
1228 | 1228 | |
1229 | 1229 | /** |
1230 | - * yikes-mailchimp-general-error-response |
|
1231 | - * |
|
1232 | - * Filter the error message displayed to the user |
|
1233 | - * |
|
1234 | - * @param string | $original_response_text | The original response message returned from the API |
|
1235 | - * @param string | $user_defined_response_text | The response message defined by the user |
|
1236 | - * @param string | $form_id | The form ID |
|
1237 | - * |
|
1238 | - * @return string | $response_text | The message that will be shown to the user |
|
1239 | - */ |
|
1230 | + * yikes-mailchimp-general-error-response |
|
1231 | + * |
|
1232 | + * Filter the error message displayed to the user |
|
1233 | + * |
|
1234 | + * @param string | $original_response_text | The original response message returned from the API |
|
1235 | + * @param string | $user_defined_response_text | The response message defined by the user |
|
1236 | + * @param string | $form_id | The form ID |
|
1237 | + * |
|
1238 | + * @return string | $response_text | The message that will be shown to the user |
|
1239 | + */ |
|
1240 | 1240 | $response_text = apply_filters( 'yikes-mailchimp-general-error-response', $original_response_text, $user_defined_response_text, $this->form_id ); |
1241 | 1241 | |
1242 | 1242 | return $response_text; |
@@ -1250,14 +1250,14 @@ discard block |
||
1250 | 1250 | } |
1251 | 1251 | |
1252 | 1252 | /** |
1253 | - * Wrap the response message in HTML for Non-AJAX form submissions |
|
1254 | - * |
|
1255 | - * @since 6.3.0 |
|
1256 | - * |
|
1257 | - * @param string | $message | The response message |
|
1258 | - * @param bool | $is_success | Boolean signifying if we're returning a success message or an error message |
|
1259 | - * @return string| The $message wrapping in HTML |
|
1260 | - */ |
|
1253 | + * Wrap the response message in HTML for Non-AJAX form submissions |
|
1254 | + * |
|
1255 | + * @since 6.3.0 |
|
1256 | + * |
|
1257 | + * @param string | $message | The response message |
|
1258 | + * @param bool | $is_success | Boolean signifying if we're returning a success message or an error message |
|
1259 | + * @return string| The $message wrapping in HTML |
|
1260 | + */ |
|
1261 | 1261 | public function wrap_form_submission_response( $message, $is_success ) { |
1262 | 1262 | |
1263 | 1263 | // If we're successful, we wrap the $message differently |
@@ -1271,14 +1271,14 @@ discard block |
||
1271 | 1271 | /**** Returning Success / Failure Functions ****/ |
1272 | 1272 | |
1273 | 1273 | /** |
1274 | - * Return success. Method of returning success based on the $is_ajax flag |
|
1275 | - * |
|
1276 | - * @since 6.3.0 |
|
1277 | - * |
|
1278 | - * @param array | $success_array | Array of success values to return |
|
1279 | - * |
|
1280 | - * @return If AJAX, return wp_send_json_success(). If not AJAX, set the global $process_submission_response variable and simply `return`. |
|
1281 | - */ |
|
1274 | + * Return success. Method of returning success based on the $is_ajax flag |
|
1275 | + * |
|
1276 | + * @since 6.3.0 |
|
1277 | + * |
|
1278 | + * @param array | $success_array | Array of success values to return |
|
1279 | + * |
|
1280 | + * @return If AJAX, return wp_send_json_success(). If not AJAX, set the global $process_submission_response variable and simply `return`. |
|
1281 | + */ |
|
1282 | 1282 | protected function yikes_success( $success_array ) { |
1283 | 1283 | if ( $this->is_ajax === true ) { |
1284 | 1284 | wp_send_json_success( $success_array ); |
@@ -1291,18 +1291,18 @@ discard block |
||
1291 | 1291 | } |
1292 | 1292 | |
1293 | 1293 | /** |
1294 | - * Return failure. Method of returning failure based on the $is_ajax flag |
|
1295 | - * |
|
1296 | - * @since 6.3.0 |
|
1297 | - * |
|
1298 | - * @param int | $hide | Flag whether to hide the form (1 = hide, 0 = do not hide) |
|
1299 | - * @param int | $error | Flag whether this is an error (1 = error, 0 = no error) |
|
1300 | - * @param string | $response | The response message to display to the user |
|
1301 | - * @param array | $additional_fields | An array of additional fields to return |
|
1302 | - * @param bool | $return_response_non_ajax | Boolean deciding if we need to return a message |
|
1303 | - * |
|
1304 | - * @return If AJAX, return $this->yikes_send_json_error(). If not AJAX, return an array || false. |
|
1305 | - */ |
|
1294 | + * Return failure. Method of returning failure based on the $is_ajax flag |
|
1295 | + * |
|
1296 | + * @since 6.3.0 |
|
1297 | + * |
|
1298 | + * @param int | $hide | Flag whether to hide the form (1 = hide, 0 = do not hide) |
|
1299 | + * @param int | $error | Flag whether this is an error (1 = error, 0 = no error) |
|
1300 | + * @param string | $response | The response message to display to the user |
|
1301 | + * @param array | $additional_fields | An array of additional fields to return |
|
1302 | + * @param bool | $return_response_non_ajax | Boolean deciding if we need to return a message |
|
1303 | + * |
|
1304 | + * @return If AJAX, return $this->yikes_send_json_error(). If not AJAX, return an array || false. |
|
1305 | + */ |
|
1306 | 1306 | protected function yikes_fail( $hide, $error, $response, $additional_fields = array(), $return_response_non_ajax = false ) { |
1307 | 1307 | if ( $this->is_ajax === true ) { |
1308 | 1308 | $this->yikes_send_json_error( $hide, $error, $response, $additional_fields ); |
@@ -1315,17 +1315,17 @@ discard block |
||
1315 | 1315 | } |
1316 | 1316 | |
1317 | 1317 | /** |
1318 | - * Wrapper function for wp_send_json_error() |
|
1319 | - * |
|
1320 | - * @since 6.3.0 |
|
1321 | - * |
|
1322 | - * @param int | $hide | Flag whether to hide the form (1 = hide, 0 = do not hide) |
|
1323 | - * @param int | $error | Flag whether this is an error (1 = error, 0 = no error) |
|
1324 | - * @param string | $translated_string | The response message to display to the user |
|
1325 | - * @param array | $additional_fields | An array of additional fields to return |
|
1326 | - * |
|
1327 | - * @return func | wp_send_json_error() |
|
1328 | - */ |
|
1318 | + * Wrapper function for wp_send_json_error() |
|
1319 | + * |
|
1320 | + * @since 6.3.0 |
|
1321 | + * |
|
1322 | + * @param int | $hide | Flag whether to hide the form (1 = hide, 0 = do not hide) |
|
1323 | + * @param int | $error | Flag whether this is an error (1 = error, 0 = no error) |
|
1324 | + * @param string | $translated_string | The response message to display to the user |
|
1325 | + * @param array | $additional_fields | An array of additional fields to return |
|
1326 | + * |
|
1327 | + * @return func | wp_send_json_error() |
|
1328 | + */ |
|
1329 | 1329 | protected function yikes_send_json_error( $hide, $error, $translated_string, $additional_fields = array() ) { |
1330 | 1330 | |
1331 | 1331 | // Default response array |
@@ -1349,14 +1349,14 @@ discard block |
||
1349 | 1349 | /** Static functions used in other places **/ |
1350 | 1350 | |
1351 | 1351 | /** |
1352 | - * Handle the redirect logic for successful submissions |
|
1353 | - * |
|
1354 | - * @since 6.3.0 |
|
1355 | - * |
|
1356 | - * @param array | $submission_settings | Array of the form's submission settings |
|
1357 | - * @param array | $page_data | Page ID |
|
1358 | - * @return array| $redirect_array | Array with two values: Redirection flag, Redirect URL |
|
1359 | - */ |
|
1352 | + * Handle the redirect logic for successful submissions |
|
1353 | + * |
|
1354 | + * @since 6.3.0 |
|
1355 | + * |
|
1356 | + * @param array | $submission_settings | Array of the form's submission settings |
|
1357 | + * @param array | $page_data | Page ID |
|
1358 | + * @return array| $redirect_array | Array with two values: Redirection flag, Redirect URL |
|
1359 | + */ |
|
1360 | 1360 | public static function handle_submission_response_success_redirect( $form_id, $submission_settings, $page_data ) { |
1361 | 1361 | |
1362 | 1362 | $default_redirect_time_ms = 1500; |
@@ -1389,23 +1389,23 @@ discard block |
||
1389 | 1389 | $redirect_url = 'custom_url' !== $redirect_page_setting ? get_permalink( $redirect_page_setting ) : $custom_redirect_setting; |
1390 | 1390 | |
1391 | 1391 | /** |
1392 | - * yikes-mailchimp-redirect-url |
|
1393 | - * |
|
1394 | - * Catch the redirect URL before it's shown to the user |
|
1395 | - * |
|
1396 | - * @param string | $redirect_url | The URL that we will redirect to |
|
1397 | - * @param string | $form_id | The ID of the current form being subscribed to |
|
1398 | - * @param array | $page_data | An array of data related to the page the form is on |
|
1399 | - */ |
|
1392 | + * yikes-mailchimp-redirect-url |
|
1393 | + * |
|
1394 | + * Catch the redirect URL before it's shown to the user |
|
1395 | + * |
|
1396 | + * @param string | $redirect_url | The URL that we will redirect to |
|
1397 | + * @param string | $form_id | The ID of the current form being subscribed to |
|
1398 | + * @param array | $page_data | An array of data related to the page the form is on |
|
1399 | + */ |
|
1400 | 1400 | $redirect_url = apply_filters( 'yikes-mailchimp-redirect-url', $redirect_url, $form_id, $page_data ); |
1401 | 1401 | |
1402 | 1402 | /** |
1403 | - * yikes-mailchimp-redirect-timer |
|
1404 | - * |
|
1405 | - * Catch the redirect timer before it's sent to the JavaScript file |
|
1406 | - * |
|
1407 | - * @param int | $default_redirect_time_ms | The default time (1500 milliseconds) to wait before redirecting |
|
1408 | - */ |
|
1403 | + * yikes-mailchimp-redirect-timer |
|
1404 | + * |
|
1405 | + * Catch the redirect timer before it's sent to the JavaScript file |
|
1406 | + * |
|
1407 | + * @param int | $default_redirect_time_ms | The default time (1500 milliseconds) to wait before redirecting |
|
1408 | + */ |
|
1409 | 1409 | $redirect_timer = apply_filters( 'yikes-mailchimp-redirect-timer', $default_redirect_time_ms, $form_id, $page_data ); |
1410 | 1410 | |
1411 | 1411 | $redirect_array['redirect_timer'] = $redirect_timer; |