convertkit / includes / functions.php

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

930 lines 21.7 KB

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 get registered abilities.
332	*
333	* @since 3.4.0
334	*
335	* @return array Abilities.
336	*/
337	function convertkit_get_abilities() {
338
339	$abilities = array();
340
341	/**
342	* Registers abilities for the Kit Plugin.
343	*
344	* @since 3.4.0
345	*
346	* @param array $abilities Abilities.
347	*/
348	$abilities = apply_filters( 'convertkit_abilities', $abilities );
349
350	return $abilities;
351
352	}
353
354	/**
355	* Helper method to return the Plugin Settings Link
356	*
357	* @since 1.9.6
358	*
359	* @param array $query_args Optional Query Args.
360	* @return string Settings Link
361	*/
362	function convertkit_get_settings_link( $query_args = array() ) {
363
364	$query_args = array_merge(
365	$query_args,
366	array(
367	'page' => '_wp_convertkit_settings',
368	)
369	);
370
371	return add_query_arg( $query_args, admin_url( 'options-general.php' ) );
372
373	}
374
375	/**
376	* Helper method to return the Plugin Settings Link
377	*
378	* @since 2.2.4
379	*
380	* @param array $query_args Optional Query Args.
381	* @return string Settings Link
382	*/
383	function convertkit_get_setup_wizard_plugin_link( $query_args = array() ) {
384
385	$query_args = array_merge(
386	$query_args,
387	array(
388	'page' => 'convertkit-setup',
389	)
390	);
391
392	return add_query_arg( $query_args, admin_url( 'options.php' ) );
393
394	}
395
396	/**
397	* Helper method to return the URL the user needs to visit to register a ConvertKit account.
398	*
399	* @since 1.9.8.4
400	*
401	* @return string ConvertKit Registration URL.
402	*/
403	function convertkit_get_registration_url() {
404
405	return add_query_arg(
406	array(
407	'utm_source' => 'wordpress',
408	'utm_term' => get_locale(),
409	'utm_content' => 'convertkit',
410	),
411	'https://app.kit.com/users/signup'
412	);
413
414	}
415
416	/**
417	* Helper method to return the URL the user needs to visit to sign in to their ConvertKit account.
418	*
419	* @since 1.9.6.1
420	*
421	* @return string ConvertKit Login URL.
422	*/
423	function convertkit_get_sign_in_url() {
424
425	return add_query_arg(
426	array(
427	'utm_source' => 'wordpress',
428	'utm_term' => get_locale(),
429	'utm_content' => 'convertkit',
430	),
431	'https://app.kit.com/'
432	);
433
434	}
435
436	/**
437	* Helper method to return the URL the user needs to visit to manage thier billing.
438	*
439	* @since 2.2.7
440	*
441	* @return string ConvertKit Billing URL.
442	*/
443	function convertkit_get_billing_url() {
444
445	return add_query_arg(
446	array(
447	'utm_source' => 'wordpress',
448	'utm_term' => get_locale(),
449	'utm_content' => 'convertkit',
450	),
451	'https://app.kit.com/account_settings/billing/'
452	);
453
454	}
455
456	/**
457	* Helper method to return the URL the user needs to visit on the ConvertKit app to create a new Form or Landing Page.
458	*
459	* @since 2.2.3
460	*
461	* @return string ConvertKit App URL
462	*/
463	function convertkit_get_new_form_url() {
464
465	return add_query_arg(
466	array(
467	'utm_source' => 'wordpress',
468	'utm_term' => get_locale(),
469	'utm_content' => 'convertkit',
470	),
471	'https://app.kit.com/forms/new/'
472	);
473
474	}
475
476	/**
477	* Helper method to return the URL the user needs to visit to edit ConvertKit forms.
478	*
479	* @since 2.2.3
480	*
481	* @return string ConvertKit Form Editor URL.
482	*/
483	function convertkit_get_form_editor_url() {
484
485	return add_query_arg(
486	array(
487	'utm_source' => 'wordpress',
488	'utm_term' => get_locale(),
489	'utm_content' => 'convertkit',
490	),
491	'https://app.kit.com/forms'
492	);
493
494	}
495
496	/**
497	* Helper method to return the URL the user needs to visit on the ConvertKit app to create a new Landing Page.
498	*
499	* @since 2.5.5
500	*
501	* @return string ConvertKit App URL
502	*/
503	function convertkit_get_new_landing_page_url() {
504
505	return add_query_arg(
506	array(
507	'utm_source' => 'wordpress',
508	'utm_term' => get_locale(),
509	'utm_content' => 'convertkit',
510	),
511	'https://app.kit.com/pages/new/'
512	);
513
514	}
515
516	/**
517	* Helper method to return the URL the user needs to visit on the ConvertKit app to create a new Tag.
518	*
519	* @since 2.3.3
520	*
521	* @return string ConvertKit App URL.
522	*/
523	function convertkit_get_new_tag_url() {
524
525	return add_query_arg(
526	array(
527	'utm_source' => 'wordpress',
528	'utm_term' => get_locale(),
529	'utm_content' => 'convertkit',
530	),
531	'https://app.kit.com/subscribers/'
532	);
533
534	}
535
536	/**
537	* Helper method to return the URL the user needs to visit on the ConvertKit app to create a new Broadcast.
538	*
539	* @since 2.2.6
540	*
541	* @return string ConvertKit App URL.
542	*/
543	function convertkit_get_new_broadcast_url() {
544
545	return add_query_arg(
546	array(
547	'utm_source' => 'wordpress',
548	'utm_term' => get_locale(),
549	'utm_content' => 'convertkit',
550	),
551	'https://app.kit.com/campaigns/'
552	);
553
554	}
555
556	/**
557	* Helper method to return the URL the user needs to visit on the ConvertKit app to edit a draft Broadcast.
558	*
559	* @since 2.4.0
560	*
561	* @param int $broadcast_id ConvertKit Broadcast ID.
562	* @return string ConvertKit App URL.
563	*/
564	function convertkit_get_edit_broadcast_url( $broadcast_id ) {
565
566	return add_query_arg(
567	array(
568	'utm_source' => 'wordpress',
569	'utm_term' => get_locale(),
570	'utm_content' => 'convertkit',
571	),
572	sprintf(
573	'https://app.kit.com/campaigns/%s/draft',
574	$broadcast_id
575	)
576	);
577
578	}
579
580	/**
581	* Helper method to return the URL the user needs to visit on the ConvertKit app to create a new Product.
582	*
583	* @since 2.2.3
584	*
585	* @return string ConvertKit App URL.
586	*/
587	function convertkit_get_new_product_url() {
588
589	return add_query_arg(
590	array(
591	'utm_source' => 'wordpress',
592	'utm_term' => get_locale(),
593	'utm_content' => 'convertkit',
594	),
595	'https://app.kit.com/products/new/'
596	);
597
598	}
599
600	/**
601	* Helper method to enqueue the frontend CSS file.
602	*
603	* @since 3.2.0
604	*/
605	function convertkit_enqueue_frontend_css() {
606
607	wp_enqueue_style( 'convertkit-frontend', CONVERTKIT_PLUGIN_URL . 'resources/frontend/css/frontend.css', array(), CONVERTKIT_PLUGIN_VERSION );
608
609	}
610
611	/**
612	* Helper method to enqueue the frontend JS file.
613	*
614	* @since 3.2.0
615	*/
616	function convertkit_enqueue_frontend_js() {
617
618	wp_enqueue_script(
619	'convertkit-js',
620	CONVERTKIT_PLUGIN_URL . 'resources/frontend/js/dist/frontend.min.js',
621	array(),
622	CONVERTKIT_PLUGIN_VERSION,
623	true
624	);
625
626	}
627
628	/**
629	* Helper method to enqueue Select2 scripts for use within the ConvertKit Plugin.
630	*
631	* @since 1.9.6.4
632	*/
633	function convertkit_select2_enqueue_scripts() {
634
635	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 );
636	wp_enqueue_script( 'convertkit-admin-select2', CONVERTKIT_PLUGIN_URL . 'resources/backend/js/select2.js', array( 'convertkit-select2' ), CONVERTKIT_PLUGIN_VERSION, false );
637
638	}
639
640	/**
641	* Helper method to enqueue Select2 stylesheets for use within the ConvertKit Plugin.
642	*
643	* @since 1.9.6.4
644	*/
645	function convertkit_select2_enqueue_styles() {
646
647	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 );
648	wp_enqueue_style( 'convertkit-admin-select2', CONVERTKIT_PLUGIN_URL . 'resources/backend/css/select2.css', array(), CONVERTKIT_PLUGIN_VERSION );
649
650	}
651
652	/**
653	* Return the contents of the given local file.
654	*
655	* @since 2.2.2
656	*
657	* @param string $local_file Local file, including path.
658	* @return string File contents.
659	*/
660	function convertkit_get_file_contents( $local_file ) {
661
662	// Bail if the file doesn't exist.
663	if ( ! file_exists( $local_file ) ) {
664	return '';
665	}
666
667	// Read file.
668	$contents = file_get_contents( $local_file ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents
669
670	// Return an empty string if the contents of the file could not be read.
671	if ( ! $contents ) {
672	return '';
673	}
674
675	// Return file's contents.
676	return $contents;
677
678	}
679
680	/**
681	* Returns a dropdown field commonly used for settings, comprising of:
682	* - Do not subscribe
683	* - Subscribe
684	* - Subscribe to Form
685	*
686	* @since 2.5.2
687	*
688	* @param string $name Field name.
689	* @param string $value Field value.
690	* @param string $id Field ID attribute.
691	* @param string $css_class Field CSS class(es).
692	* @param string $context Resource context.
693	* @param bool\|array $additional_options Additional <option> key/value pairs.
694	*/
695	function convertkit_get_subscription_dropdown_field( $name, $value, $id, $css_class = '', $context = '', $additional_options = false ) { // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter
696
697	// Load resource classes.
698	$forms = new ConvertKit_Resource_Forms( $context );
699	$tags = new ConvertKit_Resource_Tags( $context );
700	$sequences = new ConvertKit_Resource_Sequences( $context );
701
702	ob_start();
703	include CONVERTKIT_PLUGIN_PATH . '/views/backend/subscription-dropdown-field.php';
704	$output = trim( ob_get_clean() );
705
706	// Return output.
707	return $output;
708
709	}
710
711	/**
712	* Helper method to safely call get_current_screen(), returning false
713	* if the function is not available or returns null.
714	*
715	* Otherwise returns the given WP_Screen property.
716	*
717	* @since 2.5.9
718	*
719	* @param string $property WP_Screen property to return.
720	* @return bool\|string
721	*/
722	function convertkit_get_current_screen( $property ) {
723
724	// Bail if we cannot determine the screen.
725	if ( ! function_exists( 'get_current_screen' ) ) {
726	return false;
727	}
728
729	// Get screen.
730	$screen = get_current_screen();
731
732	// Bail if the screen couldn't be determined.
733	if ( is_null( $screen ) ) {
734	return false;
735	}
736
737	// Return property.
738	return $screen->$property;
739
740	}
741
742	/**
743	* Outputs the Intercom help widget script.
744	*
745	* @since 2.7.2
746	*/
747	function convertkit_output_intercom_messenger() {
748
749	?>
750	<script>
751	const KIT_INTERCOM_APP_ID = 'e4n3xtxz';
752	window.intercomSettings = {
753	api_base: 'https://api-iam.intercom.io',
754	app_id: KIT_INTERCOM_APP_ID
755	};
756	</script>
757
758	<script>
759	(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);}}})();
760	</script>
761	<?php
762
763	}
764
765	/**
766	* Checks if the given Theme is active.
767	*
768	* @since 3.1.4
769	*
770	* @param string $theme_name Theme name.
771	* @return bool
772	*/
773	function convertkit_is_theme_active( $theme_name ) {
774
775	// Assume Theme isn't active if we can't detect it.
776	if ( ! function_exists( 'wp_get_theme' ) ) {
777	return false;
778	}
779
780	// Check the Parent Theme if we're on a Child Theme.
781	if ( wp_get_theme()->parent() ) {
782	$theme = wp_get_theme()->parent();
783	} else {
784	$theme = wp_get_theme();
785	}
786
787	return strtolower( $theme->get( 'Name' ) ) === strtolower( $theme_name );
788
789	}
790
791	/**
792	* Returns permitted HTML output when using wp_kses( ..., convertkit_kses_allowed_html()).
793	*
794	* @since 2.8.5
795	*/
796	function convertkit_kses_allowed_html() {
797
798	// Get WordPress' permitted HTML elements.
799	$elements = wp_kses_allowed_html( 'post' );
800
801	// Add form elements.
802	$form_elements = array(
803	'input' => array(
804	'type' => true,
805	'id' => true,
806	'name' => true,
807	'class' => true,
808	'value' => true,
809	'checked' => true,
810	'min' => true,
811	'max' => true,
812	'step' => true,
813	'data-*' => true,
814	),
815	'select' => array(
816	'id' => true,
817	'name' => true,
818	'class' => true,
819	'size' => true,
820	'multiple' => true,
821	'data-*' => true,
822	),
823	'option' => array(
824	'value' => true,
825	'selected' => true,
826	'data-*' => true,
827	),
828	'optgroup' => array(
829	'label' => true,
830	'data-*' => true,
831	),
832	'label' => array(
833	'for' => true,
834	),
835	);
836
837	return array_merge( $elements, $form_elements );
838
839	}
840
841	/**
842	* Saves the new access token, refresh token and its expiry, and schedules
843	* a WordPress Cron event to refresh the token on expiry.
844	*
845	* @since 3.1.1
846	*
847	* @param array $result New Access Token, Refresh Token and Expiry.
848	* @param string $client_id OAuth Client ID used for the Access and Refresh Tokens.
849	*/
850	function convertkit_maybe_update_credentials( $result, $client_id ) {
851
852	// Don't save these credentials if they're not for this Client ID.
853	// They're for another Kit Plugin that uses OAuth.
854	if ( $client_id !== CONVERTKIT_OAUTH_CLIENT_ID ) {
855	return;
856	}
857
858	$settings = new ConvertKit_Settings();
859	$settings->update_credentials( $result );
860
861	}
862
863	/**
864	* Deletes the stored access token, refresh token and its expiry from the Plugin settings,
865	* and clears any existing scheduled WordPress Cron event to refresh the token on expiry,
866	* when the user revokes the access token.
867	*
868	* @since 3.2.4
869	*
870	* @param string $client_id OAuth Client ID used for the Access and Refresh Tokens.
871	*/
872	function convertkit_delete_credentials( $client_id ) {
873
874	// Don't delete these credentials if they're not for this Client ID.
875	// They're for another Kit Plugin that uses OAuth.
876	if ( $client_id !== CONVERTKIT_OAUTH_CLIENT_ID ) {
877	return;
878	}
879
880	// Delete Access and Refresh Tokens.
881	$settings = new ConvertKit_Settings();
882	$settings->delete_credentials();
883
884	}
885
886	/**
887	* Deletes the stored access token, refresh token and its expiry from the Plugin settings,
888	* and clears any existing scheduled WordPress Cron event to refresh the token on expiry,
889	* when either:
890	* - The access token is invalid
891	* - The access token expired, and refreshing failed
892	*
893	* @since 3.1.1
894	*
895	* @param WP_Error $result Error result.
896	* @param string $client_id OAuth Client ID used for the Access and Refresh Tokens.
897	*/
898	function convertkit_maybe_delete_credentials( $result, $client_id ) {
899
900	// Don't save these credentials if they're not for this Client ID.
901	// They're for another Kit Plugin that uses OAuth.
902	if ( $client_id !== CONVERTKIT_OAUTH_CLIENT_ID ) {
903	return;
904	}
905
906	// If the error isn't a 401, don't delete credentials.
907	// This could be e.g. a temporary network error, rate limit or similar.
908	if ( $result->get_error_data( 'convertkit_api_error' ) !== 401 ) {
909	return;
910	}
911
912	// Persist an error notice in the WordPress Administration until the user fixes the problem.
913	WP_ConvertKit()->get_class( 'admin_notices' )->add( 'authorization_failed' );
914
915	$settings = new ConvertKit_Settings();
916	$settings->delete_credentials();
917
918	}
919
920	// Update Access Token when refreshed by the API class.
921	add_action( 'convertkit_api_get_access_token', 'convertkit_maybe_update_credentials', 10, 2 );
922	add_action( 'convertkit_api_refresh_token', 'convertkit_maybe_update_credentials', 10, 2 );
923
924	// Delete credentials when the user revokes the access and refresh tokens.
925	add_action( 'convertkit_api_revoke_tokens', 'convertkit_delete_credentials', 10, 1 );
926
927	// Delete credentials if the API class uses a invalid access token.
928	// This prevents the Plugin making repetitive API requests that will 401.
929	add_action( 'convertkit_api_access_token_invalid', 'convertkit_maybe_delete_credentials', 10, 2 );
930