PluginProbe
Kit (formerly ConvertKit) – Email Newsletter, Email Marketing, Membership, Subscribers and Landing Pages / 3.3.9
Kit (formerly ConvertKit) – Email Newsletter, Email Marketing, Membership, Subscribers and Landing Pages v3.3.9
3.4.1 3.4.0 3.3.9 3.3.8 3.3.7 3.3.6 3.3.5 3.3.4 3.3.3 3.3.2 3.3.1 2.2.0 2.2.1 2.2.2 2.2.3 2.2.4 2.2.5 2.2.6 2.2.7 2.2.8 2.2.9 2.3.0 2.3.1 2.3.2 2.3.3 All 194 releases
convertkit / includes / functions.php

functions.php in Kit (formerly ConvertKit) – Email Newsletter, Email Marketing, Membership, Subscribers and Landing Pages 3.3.9, at includes/functions.php

906 lines 21.3 KB
No matching file
Up and down to move Enter to open Esc to close
Raw Download Zip
1 <?php
2 /**
3 * ConvertKit general plugin functions.
4 *
5 * @package ConvertKit
6 * @author ConvertKit
7 */
8
9 /**
10 * Runs the activation and update routines when the plugin is activated.
11 *
12 * @since 1.9.7.4
13 *
14 * @param bool $network_wide Is network wide activation.
15 */
16 function convertkit_plugin_activate( $network_wide ) {
17
18 // Initialise Plugin.
19 $convertkit = WP_ConvertKit();
20 $convertkit->initialize();
21
22 // Check if we are on a multisite install, activating network wide, or a single install.
23 if ( ! is_multisite() || ! $network_wide ) {
24 // Single Site activation.
25 $convertkit->get_class( 'setup' )->activate();
26
27 // Set a transient for 30 seconds to redirect to the setup screen on activation.
28 set_transient( 'convertkit-setup', true, 30 );
29 } else {
30 // Multisite network wide activation.
31 $sites = get_sites(
32 array(
33 'number' => 0,
34 )
35 );
36 foreach ( $sites as $site ) {
37 switch_to_blog( (int) $site->blog_id );
38 $convertkit->get_class( 'setup' )->activate();
39 restore_current_blog();
40 }
41 }
42
43 }
44
45 /**
46 * Runs the activation and update routines when the plugin is activated
47 * on a WordPress multisite setup.
48 *
49 * @since 1.9.7.4
50 *
51 * @param WP_Site|int $site_or_blog_id WP_Site or Blog ID.
52 */
53 function convertkit_plugin_activate_new_site( $site_or_blog_id ) {
54
55 // Check if $site_or_blog_id is a WP_Site or a blog ID.
56 if ( is_a( $site_or_blog_id, 'WP_Site' ) ) {
57 $site_or_blog_id = $site_or_blog_id->blog_id;
58 }
59
60 // Initialise Plugin.
61 $convertkit = WP_ConvertKit();
62 $convertkit->initialize();
63
64 // Run installation routine.
65 switch_to_blog( $site_or_blog_id );
66 $convertkit->get_class( 'setup' )->activate();
67 restore_current_blog();
68
69 }
70
71 /**
72 * Runs the deactivation routine when the plugin is deactivated.
73 *
74 * @since 1.9.7.4
75 *
76 * @param bool $network_wide Is network wide deactivation.
77 */
78 function convertkit_plugin_deactivate( $network_wide ) {
79
80 // Initialise Plugin.
81 $convertkit = WP_ConvertKit();
82 $convertkit->initialize();
83
84 // Check if we are on a multisite install, activating network wide, or a single install.
85 if ( ! is_multisite() || ! $network_wide ) {
86 // Single Site activation.
87 $convertkit->get_class( 'setup' )->deactivate();
88 } else {
89 // Multisite network wide activation.
90 $sites = get_sites(
91 array(
92 'number' => 0,
93 )
94 );
95 foreach ( $sites as $site ) {
96 switch_to_blog( (int) $site->blog_id );
97 $convertkit->get_class( 'setup' )->deactivate();
98 restore_current_blog();
99 }
100 }
101
102 }
103
104 /**
105 * Helper method to get supported Post Types.
106 *
107 * @since 1.9.6
108 *
109 * @return array Post Types
110 */
111 function convertkit_get_supported_post_types() {
112
113 // Define supported Post Types.
114 $post_types = array(
115 'page',
116 'post',
117 );
118
119 // If public Custom Post Types can be fetched, include them now.
120 if ( function_exists( 'get_post_types' ) ) {
121 // Get public Custom Post Types.
122 $custom_post_types = (array) get_post_types(
123 array(
124 'public' => true,
125
126 // Don't include WordPress' built in Post Types, such as attachment, revisino and nav_menu_item.
127 '_builtin' => false,
128 )
129 );
130
131 $post_types = array_merge(
132 $post_types,
133 array_keys( $custom_post_types )
134 );
135 }
136
137 /**
138 * Defines the Post Types that support ConvertKit Forms.
139 *
140 * @since 1.9.6
141 *
142 * @param array $post_types Post Types
143 */
144 $post_types = apply_filters( 'convertkit_get_supported_post_types', $post_types );
145
146 return $post_types;
147
148 }
149
150 /**
151 * Determines whether the current user can create and publish the given Post Type.
152 *
153 * @since 3.3.9
154 *
155 * @param string $post_type Post Type.
156 * @return bool User can create and publish Post Type.
157 */
158 function convertkit_user_can_create_published_post_type( $post_type ) {
159
160 $post_type_object = get_post_type_object( $post_type );
161
162 if ( ! $post_type_object ) {
163 return false;
164 }
165
166 return current_user_can( $post_type_object->cap->create_posts ) && current_user_can( $post_type_object->cap->publish_posts );
167
168 }
169
170 /**
171 * Helper method to get supported Post Types for Restricted Content (Member's Content)
172 *
173 * @since 2.1.0
174 *
175 * @deprecated 2.4.3 No longer used by internal code and not recommended. Use `convertkit_get_supported_post_types` instead.
176 *
177 * @return array Post Types
178 */
179 function convertkit_get_supported_restrict_content_post_types() {
180
181 return convertkit_get_supported_post_types();
182
183 }
184
185 /**
186 * Helper method to get registered Shortcodes.
187 *
188 * @since 1.9.6.5
189 *
190 * @return array Shortcodes
191 */
192 function convertkit_get_shortcodes() {
193
194 $shortcodes = array();
195
196 /**
197 * Registers shortcodes for the ConvertKit Plugin.
198 *
199 * @since 1.9.6.5
200 *
201 * @param array $shortcodes Shortcodes
202 */
203 $shortcodes = apply_filters( 'convertkit_shortcodes', $shortcodes );
204
205 return $shortcodes;
206
207 }
208
209 /**
210 * Helper method to get registered Blocks.
211 *
212 * @since 1.9.6
213 *
214 * @return array Blocks
215 */
216 function convertkit_get_blocks() {
217
218 $blocks = array();
219
220 /**
221 * Registers blocks for the ConvertKit Plugin.
222 *
223 * @since 1.9.6
224 *
225 * @param array $blocks Blocks
226 */
227 $blocks = apply_filters( 'convertkit_blocks', $blocks );
228
229 return $blocks;
230
231 }
232
233 /**
234 * Helper method to get registered Block formatters for Gutenberg.
235 *
236 * @since 2.2.0
237 *
238 * @return array Block formatters
239 */
240 function convertkit_get_block_formatters() {
241
242 $block_formatters = array();
243
244 /**
245 * Registers block formatters in Gutenberg for the ConvertKit Plugin.
246 *
247 * @since 2.2.0
248 *
249 * @param array $block_formatters Block formatters.
250 */
251 $block_formatters = apply_filters( 'convertkit_get_block_formatters', $block_formatters );
252
253 return $block_formatters;
254
255 }
256
257 /**
258 * Helper method to get registered plugin sidebars.
259 *
260 * @since 3.3.0
261 *
262 * @return array Plugin sidebars
263 */
264 function convertkit_get_plugin_sidebars() {
265
266 $plugin_sidebars = array();
267
268 /**
269 * Registers plugin sidebars for the WordPress block editor.
270 *
271 * @since 3.3.0
272 *
273 * @param array $plugin_sidebars Plugin sidebars.
274 */
275 $plugin_sidebars = apply_filters( 'convertkit_plugin_sidebars', $plugin_sidebars );
276
277 return $plugin_sidebars;
278
279 }
280
281 /**
282 * Helper method to get registered pre-publish actions.
283 *
284 * @since 2.4.0
285 *
286 * @return array Pre-publish actions
287 */
288 function convertkit_get_pre_publish_actions() {
289
290 $pre_publish_actions = array();
291
292 /**
293 * Registers pre-publish actions for the ConvertKit Plugin.
294 *
295 * @since 2.4.0
296 *
297 * @param array $pre_publish_panels Pre-publish actions.
298 */
299 $pre_publish_actions = apply_filters( 'convertkit_get_pre_publish_actions', $pre_publish_actions );
300
301 return $pre_publish_actions;
302
303 }
304
305 /**
306 * Helper method to get registered importers that can replace third party
307 * form shortcodes and blocks with Kit form shortcodes and blocks.
308 *
309 * @since 3.1.7
310 *
311 * @return array Importers.
312 */
313 function convertkit_get_form_importers() {
314
315 $importers = array();
316
317 /**
318 * Registers form importers for the ConvertKit Plugin.
319 *
320 * @since 3.1.7
321 *
322 * @param array $importers Importers.
323 */
324 $importers = apply_filters( 'convertkit_get_form_importers', $importers );
325
326 return $importers;
327
328 }
329
330 /**
331 * Helper method to return the Plugin Settings Link
332 *
333 * @since 1.9.6
334 *
335 * @param array $query_args Optional Query Args.
336 * @return string Settings Link
337 */
338 function convertkit_get_settings_link( $query_args = array() ) {
339
340 $query_args = array_merge(
341 $query_args,
342 array(
343 'page' => '_wp_convertkit_settings',
344 )
345 );
346
347 return add_query_arg( $query_args, admin_url( 'options-general.php' ) );
348
349 }
350
351 /**
352 * Helper method to return the Plugin Settings Link
353 *
354 * @since 2.2.4
355 *
356 * @param array $query_args Optional Query Args.
357 * @return string Settings Link
358 */
359 function convertkit_get_setup_wizard_plugin_link( $query_args = array() ) {
360
361 $query_args = array_merge(
362 $query_args,
363 array(
364 'page' => 'convertkit-setup',
365 )
366 );
367
368 return add_query_arg( $query_args, admin_url( 'options.php' ) );
369
370 }
371
372 /**
373 * Helper method to return the URL the user needs to visit to register a ConvertKit account.
374 *
375 * @since 1.9.8.4
376 *
377 * @return string ConvertKit Registration URL.
378 */
379 function convertkit_get_registration_url() {
380
381 return add_query_arg(
382 array(
383 'utm_source' => 'wordpress',
384 'utm_term' => get_locale(),
385 'utm_content' => 'convertkit',
386 ),
387 'https://app.kit.com/users/signup'
388 );
389
390 }
391
392 /**
393 * Helper method to return the URL the user needs to visit to sign in to their ConvertKit account.
394 *
395 * @since 1.9.6.1
396 *
397 * @return string ConvertKit Login URL.
398 */
399 function convertkit_get_sign_in_url() {
400
401 return add_query_arg(
402 array(
403 'utm_source' => 'wordpress',
404 'utm_term' => get_locale(),
405 'utm_content' => 'convertkit',
406 ),
407 'https://app.kit.com/'
408 );
409
410 }
411
412 /**
413 * Helper method to return the URL the user needs to visit to manage thier billing.
414 *
415 * @since 2.2.7
416 *
417 * @return string ConvertKit Billing URL.
418 */
419 function convertkit_get_billing_url() {
420
421 return add_query_arg(
422 array(
423 'utm_source' => 'wordpress',
424 'utm_term' => get_locale(),
425 'utm_content' => 'convertkit',
426 ),
427 'https://app.kit.com/account_settings/billing/'
428 );
429
430 }
431
432 /**
433 * Helper method to return the URL the user needs to visit on the ConvertKit app to create a new Form or Landing Page.
434 *
435 * @since 2.2.3
436 *
437 * @return string ConvertKit App URL
438 */
439 function convertkit_get_new_form_url() {
440
441 return add_query_arg(
442 array(
443 'utm_source' => 'wordpress',
444 'utm_term' => get_locale(),
445 'utm_content' => 'convertkit',
446 ),
447 'https://app.kit.com/forms/new/'
448 );
449
450 }
451
452 /**
453 * Helper method to return the URL the user needs to visit to edit ConvertKit forms.
454 *
455 * @since 2.2.3
456 *
457 * @return string ConvertKit Form Editor URL.
458 */
459 function convertkit_get_form_editor_url() {
460
461 return add_query_arg(
462 array(
463 'utm_source' => 'wordpress',
464 'utm_term' => get_locale(),
465 'utm_content' => 'convertkit',
466 ),
467 'https://app.kit.com/forms'
468 );
469
470 }
471
472 /**
473 * Helper method to return the URL the user needs to visit on the ConvertKit app to create a new Landing Page.
474 *
475 * @since 2.5.5
476 *
477 * @return string ConvertKit App URL
478 */
479 function convertkit_get_new_landing_page_url() {
480
481 return add_query_arg(
482 array(
483 'utm_source' => 'wordpress',
484 'utm_term' => get_locale(),
485 'utm_content' => 'convertkit',
486 ),
487 'https://app.kit.com/pages/new/'
488 );
489
490 }
491
492 /**
493 * Helper method to return the URL the user needs to visit on the ConvertKit app to create a new Tag.
494 *
495 * @since 2.3.3
496 *
497 * @return string ConvertKit App URL.
498 */
499 function convertkit_get_new_tag_url() {
500
501 return add_query_arg(
502 array(
503 'utm_source' => 'wordpress',
504 'utm_term' => get_locale(),
505 'utm_content' => 'convertkit',
506 ),
507 'https://app.kit.com/subscribers/'
508 );
509
510 }
511
512 /**
513 * Helper method to return the URL the user needs to visit on the ConvertKit app to create a new Broadcast.
514 *
515 * @since 2.2.6
516 *
517 * @return string ConvertKit App URL.
518 */
519 function convertkit_get_new_broadcast_url() {
520
521 return add_query_arg(
522 array(
523 'utm_source' => 'wordpress',
524 'utm_term' => get_locale(),
525 'utm_content' => 'convertkit',
526 ),
527 'https://app.kit.com/campaigns/'
528 );
529
530 }
531
532 /**
533 * Helper method to return the URL the user needs to visit on the ConvertKit app to edit a draft Broadcast.
534 *
535 * @since 2.4.0
536 *
537 * @param int $broadcast_id ConvertKit Broadcast ID.
538 * @return string ConvertKit App URL.
539 */
540 function convertkit_get_edit_broadcast_url( $broadcast_id ) {
541
542 return add_query_arg(
543 array(
544 'utm_source' => 'wordpress',
545 'utm_term' => get_locale(),
546 'utm_content' => 'convertkit',
547 ),
548 sprintf(
549 'https://app.kit.com/campaigns/%s/draft',
550 $broadcast_id
551 )
552 );
553
554 }
555
556 /**
557 * Helper method to return the URL the user needs to visit on the ConvertKit app to create a new Product.
558 *
559 * @since 2.2.3
560 *
561 * @return string ConvertKit App URL.
562 */
563 function convertkit_get_new_product_url() {
564
565 return add_query_arg(
566 array(
567 'utm_source' => 'wordpress',
568 'utm_term' => get_locale(),
569 'utm_content' => 'convertkit',
570 ),
571 'https://app.kit.com/products/new/'
572 );
573
574 }
575
576 /**
577 * Helper method to enqueue the frontend CSS file.
578 *
579 * @since 3.2.0
580 */
581 function convertkit_enqueue_frontend_css() {
582
583 wp_enqueue_style( 'convertkit-frontend', CONVERTKIT_PLUGIN_URL . 'resources/frontend/css/frontend.css', array(), CONVERTKIT_PLUGIN_VERSION );
584
585 }
586
587 /**
588 * Helper method to enqueue the frontend JS file.
589 *
590 * @since 3.2.0
591 */
592 function convertkit_enqueue_frontend_js() {
593
594 wp_enqueue_script(
595 'convertkit-js',
596 CONVERTKIT_PLUGIN_URL . 'resources/frontend/js/dist/frontend.min.js',
597 array(),
598 CONVERTKIT_PLUGIN_VERSION,
599 true
600 );
601
602 }
603
604 /**
605 * Helper method to enqueue Select2 scripts for use within the ConvertKit Plugin.
606 *
607 * @since 1.9.6.4
608 */
609 function convertkit_select2_enqueue_scripts() {
610
611 wp_enqueue_script( 'convertkit-select2', 'https://cdn.jsdelivr.net/npm/select2@4.1.0-rc.0/dist/js/select2.min.js', array( 'jquery' ), CONVERTKIT_PLUGIN_VERSION, false );
612 wp_enqueue_script( 'convertkit-admin-select2', CONVERTKIT_PLUGIN_URL . 'resources/backend/js/select2.js', array( 'convertkit-select2' ), CONVERTKIT_PLUGIN_VERSION, false );
613
614 }
615
616 /**
617 * Helper method to enqueue Select2 stylesheets for use within the ConvertKit Plugin.
618 *
619 * @since 1.9.6.4
620 */
621 function convertkit_select2_enqueue_styles() {
622
623 wp_enqueue_style( 'convertkit-select2', 'https://cdn.jsdelivr.net/npm/select2@4.1.0-rc.0/dist/css/select2.min.css', array(), CONVERTKIT_PLUGIN_VERSION );
624 wp_enqueue_style( 'convertkit-admin-select2', CONVERTKIT_PLUGIN_URL . 'resources/backend/css/select2.css', array(), CONVERTKIT_PLUGIN_VERSION );
625
626 }
627
628 /**
629 * Return the contents of the given local file.
630 *
631 * @since 2.2.2
632 *
633 * @param string $local_file Local file, including path.
634 * @return string File contents.
635 */
636 function convertkit_get_file_contents( $local_file ) {
637
638 // Bail if the file doesn't exist.
639 if ( ! file_exists( $local_file ) ) {
640 return '';
641 }
642
643 // Read file.
644 $contents = file_get_contents( $local_file ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents
645
646 // Return an empty string if the contents of the file could not be read.
647 if ( ! $contents ) {
648 return '';
649 }
650
651 // Return file's contents.
652 return $contents;
653
654 }
655
656 /**
657 * Returns a dropdown field commonly used for settings, comprising of:
658 * - Do not subscribe
659 * - Subscribe
660 * - Subscribe to Form
661 *
662 * @since 2.5.2
663 *
664 * @param string $name Field name.
665 * @param string $value Field value.
666 * @param string $id Field ID attribute.
667 * @param string $css_class Field CSS class(es).
668 * @param string $context Resource context.
669 * @param bool|array $additional_options Additional <option> key/value pairs.
670 */
671 function convertkit_get_subscription_dropdown_field( $name, $value, $id, $css_class = '', $context = '', $additional_options = false ) { // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter
672
673 // Load resource classes.
674 $forms = new ConvertKit_Resource_Forms( $context );
675 $tags = new ConvertKit_Resource_Tags( $context );
676 $sequences = new ConvertKit_Resource_Sequences( $context );
677
678 ob_start();
679 include CONVERTKIT_PLUGIN_PATH . '/views/backend/subscription-dropdown-field.php';
680 $output = trim( ob_get_clean() );
681
682 // Return output.
683 return $output;
684
685 }
686
687 /**
688 * Helper method to safely call get_current_screen(), returning false
689 * if the function is not available or returns null.
690 *
691 * Otherwise returns the given WP_Screen property.
692 *
693 * @since 2.5.9
694 *
695 * @param string $property WP_Screen property to return.
696 * @return bool|string
697 */
698 function convertkit_get_current_screen( $property ) {
699
700 // Bail if we cannot determine the screen.
701 if ( ! function_exists( 'get_current_screen' ) ) {
702 return false;
703 }
704
705 // Get screen.
706 $screen = get_current_screen();
707
708 // Bail if the screen couldn't be determined.
709 if ( is_null( $screen ) ) {
710 return false;
711 }
712
713 // Return property.
714 return $screen->$property;
715
716 }
717
718 /**
719 * Outputs the Intercom help widget script.
720 *
721 * @since 2.7.2
722 */
723 function convertkit_output_intercom_messenger() {
724
725 ?>
726 <script>
727 const KIT_INTERCOM_APP_ID = 'e4n3xtxz';
728 window.intercomSettings = {
729 api_base: 'https://api-iam.intercom.io',
730 app_id: KIT_INTERCOM_APP_ID
731 };
732 </script>
733
734 <script>
735 (function(){var w=window;var ic=w.Intercom;if(typeof ic==="function"){ic('update',w.intercomSettings);}else{var d=document;var i=function(){i.c(arguments);};i.q=[];i.c=function(args){i.q.push(args);};w.Intercom=i;var l=function(){var s=d.createElement('script');s.type='text/javascript';s.async=true;s.src='https://widget.intercom.io/widget/' + KIT_INTERCOM_APP_ID;var x=d.getElementsByTagName('script')[0];x.parentNode.insertBefore(s, x);};if(document.readyState==='complete'){l();}else if(w.attachEvent){w.attachEvent('onload',l);}else{w.addEventListener('load',l,false);}}})();
736 </script>
737 <?php
738
739 }
740
741 /**
742 * Checks if the given Theme is active.
743 *
744 * @since 3.1.4
745 *
746 * @param string $theme_name Theme name.
747 * @return bool
748 */
749 function convertkit_is_theme_active( $theme_name ) {
750
751 // Assume Theme isn't active if we can't detect it.
752 if ( ! function_exists( 'wp_get_theme' ) ) {
753 return false;
754 }
755
756 // Check the Parent Theme if we're on a Child Theme.
757 if ( wp_get_theme()->parent() ) {
758 $theme = wp_get_theme()->parent();
759 } else {
760 $theme = wp_get_theme();
761 }
762
763 return strtolower( $theme->get( 'Name' ) ) === strtolower( $theme_name );
764
765 }
766
767 /**
768 * Returns permitted HTML output when using wp_kses( ..., convertkit_kses_allowed_html()).
769 *
770 * @since 2.8.5
771 */
772 function convertkit_kses_allowed_html() {
773
774 // Get WordPress' permitted HTML elements.
775 $elements = wp_kses_allowed_html( 'post' );
776
777 // Add form elements.
778 $form_elements = array(
779 'input' => array(
780 'type' => true,
781 'id' => true,
782 'name' => true,
783 'class' => true,
784 'value' => true,
785 'checked' => true,
786 'min' => true,
787 'max' => true,
788 'step' => true,
789 'data-*' => true,
790 ),
791 'select' => array(
792 'id' => true,
793 'name' => true,
794 'class' => true,
795 'size' => true,
796 'multiple' => true,
797 'data-*' => true,
798 ),
799 'option' => array(
800 'value' => true,
801 'selected' => true,
802 'data-*' => true,
803 ),
804 'optgroup' => array(
805 'label' => true,
806 'data-*' => true,
807 ),
808 'label' => array(
809 'for' => true,
810 ),
811 );
812
813 return array_merge( $elements, $form_elements );
814
815 }
816
817 /**
818 * Saves the new access token, refresh token and its expiry, and schedules
819 * a WordPress Cron event to refresh the token on expiry.
820 *
821 * @since 3.1.1
822 *
823 * @param array $result New Access Token, Refresh Token and Expiry.
824 * @param string $client_id OAuth Client ID used for the Access and Refresh Tokens.
825 */
826 function convertkit_maybe_update_credentials( $result, $client_id ) {
827
828 // Don't save these credentials if they're not for this Client ID.
829 // They're for another Kit Plugin that uses OAuth.
830 if ( $client_id !== CONVERTKIT_OAUTH_CLIENT_ID ) {
831 return;
832 }
833
834 $settings = new ConvertKit_Settings();
835 $settings->update_credentials( $result );
836
837 }
838
839 /**
840 * Deletes the stored access token, refresh token and its expiry from the Plugin settings,
841 * and clears any existing scheduled WordPress Cron event to refresh the token on expiry,
842 * when the user revokes the access token.
843 *
844 * @since 3.2.4
845 *
846 * @param string $client_id OAuth Client ID used for the Access and Refresh Tokens.
847 */
848 function convertkit_delete_credentials( $client_id ) {
849
850 // Don't delete these credentials if they're not for this Client ID.
851 // They're for another Kit Plugin that uses OAuth.
852 if ( $client_id !== CONVERTKIT_OAUTH_CLIENT_ID ) {
853 return;
854 }
855
856 // Delete Access and Refresh Tokens.
857 $settings = new ConvertKit_Settings();
858 $settings->delete_credentials();
859
860 }
861
862 /**
863 * Deletes the stored access token, refresh token and its expiry from the Plugin settings,
864 * and clears any existing scheduled WordPress Cron event to refresh the token on expiry,
865 * when either:
866 * - The access token is invalid
867 * - The access token expired, and refreshing failed
868 *
869 * @since 3.1.1
870 *
871 * @param WP_Error $result Error result.
872 * @param string $client_id OAuth Client ID used for the Access and Refresh Tokens.
873 */
874 function convertkit_maybe_delete_credentials( $result, $client_id ) {
875
876 // Don't save these credentials if they're not for this Client ID.
877 // They're for another Kit Plugin that uses OAuth.
878 if ( $client_id !== CONVERTKIT_OAUTH_CLIENT_ID ) {
879 return;
880 }
881
882 // If the error isn't a 401, don't delete credentials.
883 // This could be e.g. a temporary network error, rate limit or similar.
884 if ( $result->get_error_data( 'convertkit_api_error' ) !== 401 ) {
885 return;
886 }
887
888 // Persist an error notice in the WordPress Administration until the user fixes the problem.
889 WP_ConvertKit()->get_class( 'admin_notices' )->add( 'authorization_failed' );
890
891 $settings = new ConvertKit_Settings();
892 $settings->delete_credentials();
893
894 }
895
896 // Update Access Token when refreshed by the API class.
897 add_action( 'convertkit_api_get_access_token', 'convertkit_maybe_update_credentials', 10, 2 );
898 add_action( 'convertkit_api_refresh_token', 'convertkit_maybe_update_credentials', 10, 2 );
899
900 // Delete credentials when the user revokes the access and refresh tokens.
901 add_action( 'convertkit_api_revoke_tokens', 'convertkit_delete_credentials', 10, 1 );
902
903 // Delete credentials if the API class uses a invalid access token.
904 // This prevents the Plugin making repetitive API requests that will 401.
905 add_action( 'convertkit_api_access_token_invalid', 'convertkit_maybe_delete_credentials', 10, 2 );
906