convertkit / includes / functions.php

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

836 lines 19.5 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	* Helper method to get supported Post Types for Restricted Content (Member's Content)
152	*
153	* @since 2.1.0
154	*
155	* @deprecated 2.4.3 No longer used by internal code and not recommended. Use `convertkit_get_supported_post_types` instead.
156	*
157	* @return array Post Types
158	*/
159	function convertkit_get_supported_restrict_content_post_types() {
160
161	return convertkit_get_supported_post_types();
162
163	}
164
165	/**
166	* Helper method to get registered Shortcodes.
167	*
168	* @since 1.9.6.5
169	*
170	* @return array Shortcodes
171	*/
172	function convertkit_get_shortcodes() {
173
174	$shortcodes = array();
175
176	/**
177	* Registers shortcodes for the ConvertKit Plugin.
178	*
179	* @since 1.9.6.5
180	*
181	* @param array $shortcodes Shortcodes
182	*/
183	$shortcodes = apply_filters( 'convertkit_shortcodes', $shortcodes );
184
185	return $shortcodes;
186
187	}
188
189	/**
190	* Helper method to get registered Blocks.
191	*
192	* @since 1.9.6
193	*
194	* @return array Blocks
195	*/
196	function convertkit_get_blocks() {
197
198	$blocks = array();
199
200	/**
201	* Registers blocks for the ConvertKit Plugin.
202	*
203	* @since 1.9.6
204	*
205	* @param array $blocks Blocks
206	*/
207	$blocks = apply_filters( 'convertkit_blocks', $blocks );
208
209	return $blocks;
210
211	}
212
213	/**
214	* Helper method to get registered Block formatters for Gutenberg.
215	*
216	* @since 2.2.0
217	*
218	* @return array Block formatters
219	*/
220	function convertkit_get_block_formatters() {
221
222	$block_formatters = array();
223
224	/**
225	* Registers block formatters in Gutenberg for the ConvertKit Plugin.
226	*
227	* @since 2.2.0
228	*
229	* @param array $block_formatters Block formatters.
230	*/
231	$block_formatters = apply_filters( 'convertkit_get_block_formatters', $block_formatters );
232
233	return $block_formatters;
234
235	}
236
237	/**
238	* Helper method to get registered pre-publish actions.
239	*
240	* @since 2.4.0
241	*
242	* @return array Pre-publish actions
243	*/
244	function convertkit_get_pre_publish_actions() {
245
246	$pre_publish_actions = array();
247
248	/**
249	* Registers pre-publish actions for the ConvertKit Plugin.
250	*
251	* @since 2.4.0
252	*
253	* @param array $pre_publish_panels Pre-publish actions.
254	*/
255	$pre_publish_actions = apply_filters( 'convertkit_get_pre_publish_actions', $pre_publish_actions );
256
257	return $pre_publish_actions;
258
259	}
260
261	/**
262	* Helper method to get registered importers that can replace third party
263	* form shortcodes and blocks with Kit form shortcodes and blocks.
264	*
265	* @since 3.1.7
266	*
267	* @return array Importers.
268	*/
269	function convertkit_get_form_importers() {
270
271	$importers = array();
272
273	/**
274	* Registers form importers for the ConvertKit Plugin.
275	*
276	* @since 3.1.7
277	*
278	* @param array $importers Importers.
279	*/
280	$importers = apply_filters( 'convertkit_get_form_importers', $importers );
281
282	return $importers;
283
284	}
285
286	/**
287	* Helper method to return the Plugin Settings Link
288	*
289	* @since 1.9.6
290	*
291	* @param array $query_args Optional Query Args.
292	* @return string Settings Link
293	*/
294	function convertkit_get_settings_link( $query_args = array() ) {
295
296	$query_args = array_merge(
297	$query_args,
298	array(
299	'page' => '_wp_convertkit_settings',
300	)
301	);
302
303	return add_query_arg( $query_args, admin_url( 'options-general.php' ) );
304
305	}
306
307	/**
308	* Helper method to return the Plugin Settings Link
309	*
310	* @since 2.2.4
311	*
312	* @param array $query_args Optional Query Args.
313	* @return string Settings Link
314	*/
315	function convertkit_get_setup_wizard_plugin_link( $query_args = array() ) {
316
317	$query_args = array_merge(
318	$query_args,
319	array(
320	'page' => 'convertkit-setup',
321	)
322	);
323
324	return add_query_arg( $query_args, admin_url( 'options.php' ) );
325
326	}
327
328	/**
329	* Helper method to return the URL the user needs to visit to register a ConvertKit account.
330	*
331	* @since 1.9.8.4
332	*
333	* @return string ConvertKit Registration URL.
334	*/
335	function convertkit_get_registration_url() {
336
337	return add_query_arg(
338	array(
339	'utm_source' => 'wordpress',
340	'utm_term' => get_locale(),
341	'utm_content' => 'convertkit',
342	),
343	'https://app.kit.com/users/signup'
344	);
345
346	}
347
348	/**
349	* Helper method to return the URL the user needs to visit to sign in to their ConvertKit account.
350	*
351	* @since 1.9.6.1
352	*
353	* @return string ConvertKit Login URL.
354	*/
355	function convertkit_get_sign_in_url() {
356
357	return add_query_arg(
358	array(
359	'utm_source' => 'wordpress',
360	'utm_term' => get_locale(),
361	'utm_content' => 'convertkit',
362	),
363	'https://app.kit.com/'
364	);
365
366	}
367
368	/**
369	* Helper method to return the URL the user needs to visit to manage thier billing.
370	*
371	* @since 2.2.7
372	*
373	* @return string ConvertKit Billing URL.
374	*/
375	function convertkit_get_billing_url() {
376
377	return add_query_arg(
378	array(
379	'utm_source' => 'wordpress',
380	'utm_term' => get_locale(),
381	'utm_content' => 'convertkit',
382	),
383	'https://app.kit.com/account_settings/billing/'
384	);
385
386	}
387
388	/**
389	* Helper method to return the URL the user needs to visit on the ConvertKit app to create a new Form or Landing Page.
390	*
391	* @since 2.2.3
392	*
393	* @return string ConvertKit App URL
394	*/
395	function convertkit_get_new_form_url() {
396
397	return add_query_arg(
398	array(
399	'utm_source' => 'wordpress',
400	'utm_term' => get_locale(),
401	'utm_content' => 'convertkit',
402	),
403	'https://app.kit.com/forms/new/'
404	);
405
406	}
407
408	/**
409	* Helper method to return the URL the user needs to visit to edit ConvertKit forms.
410	*
411	* @since 2.2.3
412	*
413	* @return string ConvertKit Form Editor URL.
414	*/
415	function convertkit_get_form_editor_url() {
416
417	return add_query_arg(
418	array(
419	'utm_source' => 'wordpress',
420	'utm_term' => get_locale(),
421	'utm_content' => 'convertkit',
422	),
423	'https://app.kit.com/forms'
424	);
425
426	}
427
428	/**
429	* Helper method to return the URL the user needs to visit on the ConvertKit app to create a new Landing Page.
430	*
431	* @since 2.5.5
432	*
433	* @return string ConvertKit App URL
434	*/
435	function convertkit_get_new_landing_page_url() {
436
437	return add_query_arg(
438	array(
439	'utm_source' => 'wordpress',
440	'utm_term' => get_locale(),
441	'utm_content' => 'convertkit',
442	),
443	'https://app.kit.com/pages/new/'
444	);
445
446	}
447
448	/**
449	* Helper method to return the URL the user needs to visit on the ConvertKit app to create a new Tag.
450	*
451	* @since 2.3.3
452	*
453	* @return string ConvertKit App URL.
454	*/
455	function convertkit_get_new_tag_url() {
456
457	return add_query_arg(
458	array(
459	'utm_source' => 'wordpress',
460	'utm_term' => get_locale(),
461	'utm_content' => 'convertkit',
462	),
463	'https://app.kit.com/subscribers/'
464	);
465
466	}
467
468	/**
469	* Helper method to return the URL the user needs to visit on the ConvertKit app to create a new Broadcast.
470	*
471	* @since 2.2.6
472	*
473	* @return string ConvertKit App URL.
474	*/
475	function convertkit_get_new_broadcast_url() {
476
477	return add_query_arg(
478	array(
479	'utm_source' => 'wordpress',
480	'utm_term' => get_locale(),
481	'utm_content' => 'convertkit',
482	),
483	'https://app.kit.com/campaigns/'
484	);
485
486	}
487
488	/**
489	* Helper method to return the URL the user needs to visit on the ConvertKit app to edit a draft Broadcast.
490	*
491	* @since 2.4.0
492	*
493	* @param int $broadcast_id ConvertKit Broadcast ID.
494	* @return string ConvertKit App URL.
495	*/
496	function convertkit_get_edit_broadcast_url( $broadcast_id ) {
497
498	return add_query_arg(
499	array(
500	'utm_source' => 'wordpress',
501	'utm_term' => get_locale(),
502	'utm_content' => 'convertkit',
503	),
504	sprintf(
505	'https://app.kit.com/campaigns/%s/draft',
506	$broadcast_id
507	)
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 Product.
514	*
515	* @since 2.2.3
516	*
517	* @return string ConvertKit App URL.
518	*/
519	function convertkit_get_new_product_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/products/new/'
528	);
529
530	}
531
532	/**
533	* Helper method to enqueue the frontend CSS file.
534	*
535	* @since 3.2.0
536	*/
537	function convertkit_enqueue_frontend_css() {
538
539	wp_enqueue_style( 'convertkit-frontend', CONVERTKIT_PLUGIN_URL . 'resources/frontend/css/frontend.css', array(), CONVERTKIT_PLUGIN_VERSION );
540
541	}
542
543	/**
544	* Helper method to enqueue the frontend JS file.
545	*
546	* @since 3.2.0
547	*/
548	function convertkit_enqueue_frontend_js() {
549
550	wp_enqueue_script(
551	'convertkit-js',
552	CONVERTKIT_PLUGIN_URL . 'resources/frontend/js/dist/frontend.min.js',
553	array(),
554	CONVERTKIT_PLUGIN_VERSION,
555	true
556	);
557
558	}
559
560	/**
561	* Helper method to enqueue Select2 scripts for use within the ConvertKit Plugin.
562	*
563	* @since 1.9.6.4
564	*/
565	function convertkit_select2_enqueue_scripts() {
566
567	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 );
568	wp_enqueue_script( 'convertkit-admin-select2', CONVERTKIT_PLUGIN_URL . 'resources/backend/js/select2.js', array( 'convertkit-select2' ), CONVERTKIT_PLUGIN_VERSION, false );
569
570	}
571
572	/**
573	* Helper method to enqueue Select2 stylesheets for use within the ConvertKit Plugin.
574	*
575	* @since 1.9.6.4
576	*/
577	function convertkit_select2_enqueue_styles() {
578
579	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 );
580	wp_enqueue_style( 'convertkit-admin-select2', CONVERTKIT_PLUGIN_URL . 'resources/backend/css/select2.css', array(), CONVERTKIT_PLUGIN_VERSION );
581
582	}
583
584	/**
585	* Return the contents of the given local file.
586	*
587	* @since 2.2.2
588	*
589	* @param string $local_file Local file, including path.
590	* @return string File contents.
591	*/
592	function convertkit_get_file_contents( $local_file ) {
593
594	// Bail if the file doesn't exist.
595	if ( ! file_exists( $local_file ) ) {
596	return '';
597	}
598
599	// Read file.
600	$contents = file_get_contents( $local_file ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents
601
602	// Return an empty string if the contents of the file could not be read.
603	if ( ! $contents ) {
604	return '';
605	}
606
607	// Return file's contents.
608	return $contents;
609
610	}
611
612	/**
613	* Returns a dropdown field commonly used for settings, comprising of:
614	* - Do not subscribe
615	* - Subscribe
616	* - Subscribe to Form
617	*
618	* @since 2.5.2
619	*
620	* @param string $name Field name.
621	* @param string $value Field value.
622	* @param string $id Field ID attribute.
623	* @param string $css_class Field CSS class(es).
624	* @param string $context Resource context.
625	* @param bool\|array $additional_options Additional <option> key/value pairs.
626	*/
627	function convertkit_get_subscription_dropdown_field( $name, $value, $id, $css_class = '', $context = '', $additional_options = false ) { // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter
628
629	// Load resource classes.
630	$forms = new ConvertKit_Resource_Forms( $context );
631	$tags = new ConvertKit_Resource_Tags( $context );
632	$sequences = new ConvertKit_Resource_Sequences( $context );
633
634	ob_start();
635	include CONVERTKIT_PLUGIN_PATH . '/views/backend/subscription-dropdown-field.php';
636	$output = trim( ob_get_clean() );
637
638	// Return output.
639	return $output;
640
641	}
642
643	/**
644	* Helper method to safely call get_current_screen(), returning false
645	* if the function is not available or returns null.
646	*
647	* Otherwise returns the given WP_Screen property.
648	*
649	* @since 2.5.9
650	*
651	* @param string $property WP_Screen property to return.
652	* @return bool\|string
653	*/
654	function convertkit_get_current_screen( $property ) {
655
656	// Bail if we cannot determine the screen.
657	if ( ! function_exists( 'get_current_screen' ) ) {
658	return false;
659	}
660
661	// Get screen.
662	$screen = get_current_screen();
663
664	// Bail if the screen couldn't be determined.
665	if ( is_null( $screen ) ) {
666	return false;
667	}
668
669	// Return property.
670	return $screen->$property;
671
672	}
673
674	/**
675	* Outputs the Intercom help widget script.
676	*
677	* @since 2.7.2
678	*/
679	function convertkit_output_intercom_messenger() {
680
681	?>
682	<script>
683	const KIT_INTERCOM_APP_ID = 'e4n3xtxz';
684	window.intercomSettings = {
685	api_base: 'https://api-iam.intercom.io',
686	app_id: KIT_INTERCOM_APP_ID
687	};
688	</script>
689
690	<script>
691	(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);}}})();
692	</script>
693	<?php
694
695	}
696
697	/**
698	* Checks if the given Theme is active.
699	*
700	* @since 3.1.4
701	*
702	* @param string $theme_name Theme name.
703	* @return bool
704	*/
705	function convertkit_is_theme_active( $theme_name ) {
706
707	// Assume Theme isn't active if we can't detect it.
708	if ( ! function_exists( 'wp_get_theme' ) ) {
709	return false;
710	}
711
712	// Check the Parent Theme if we're on a Child Theme.
713	if ( wp_get_theme()->parent() ) {
714	$theme = wp_get_theme()->parent();
715	} else {
716	$theme = wp_get_theme();
717	}
718
719	return strtolower( $theme->get( 'Name' ) ) === strtolower( $theme_name );
720
721	}
722
723	/**
724	* Returns permitted HTML output when using wp_kses( ..., convertkit_kses_allowed_html()).
725	*
726	* @since 2.8.5
727	*/
728	function convertkit_kses_allowed_html() {
729
730	// Get WordPress' permitted HTML elements.
731	$elements = wp_kses_allowed_html( 'post' );
732
733	// Add form elements.
734	$form_elements = array(
735	'input' => array(
736	'type' => true,
737	'id' => true,
738	'name' => true,
739	'class' => true,
740	'value' => true,
741	'checked' => true,
742	'min' => true,
743	'max' => true,
744	'step' => true,
745	'data-*' => true,
746	),
747	'select' => array(
748	'id' => true,
749	'name' => true,
750	'class' => true,
751	'size' => true,
752	'multiple' => true,
753	'data-*' => true,
754	),
755	'option' => array(
756	'value' => true,
757	'selected' => true,
758	'data-*' => true,
759	),
760	'optgroup' => array(
761	'label' => true,
762	'data-*' => true,
763	),
764	'label' => array(
765	'for' => true,
766	),
767	);
768
769	return array_merge( $elements, $form_elements );
770
771	}
772
773	/**
774	* Saves the new access token, refresh token and its expiry, and schedules
775	* a WordPress Cron event to refresh the token on expiry.
776	*
777	* @since 3.1.1
778	*
779	* @param array $result New Access Token, Refresh Token and Expiry.
780	* @param string $client_id OAuth Client ID used for the Access and Refresh Tokens.
781	*/
782	function convertkit_maybe_update_credentials( $result, $client_id ) {
783
784	// Don't save these credentials if they're not for this Client ID.
785	// They're for another Kit Plugin that uses OAuth.
786	if ( $client_id !== CONVERTKIT_OAUTH_CLIENT_ID ) {
787	return;
788	}
789
790	$settings = new ConvertKit_Settings();
791	$settings->update_credentials( $result );
792
793	}
794
795	/**
796	* Deletes the stored access token, refresh token and its expiry from the Plugin settings,
797	* and clears any existing scheduled WordPress Cron event to refresh the token on expiry,
798	* when either:
799	* - The access token is invalid
800	* - The access token expired, and refreshing failed
801	*
802	* @since 3.1.1
803	*
804	* @param WP_Error $result Error result.
805	* @param string $client_id OAuth Client ID used for the Access and Refresh Tokens.
806	*/
807	function convertkit_maybe_delete_credentials( $result, $client_id ) {
808
809	// Don't save these credentials if they're not for this Client ID.
810	// They're for another Kit Plugin that uses OAuth.
811	if ( $client_id !== CONVERTKIT_OAUTH_CLIENT_ID ) {
812	return;
813	}
814
815	// If the error isn't a 401, don't delete credentials.
816	// This could be e.g. a temporary network error, rate limit or similar.
817	if ( $result->get_error_data( 'convertkit_api_error' ) !== 401 ) {
818	return;
819	}
820
821	// Persist an error notice in the WordPress Administration until the user fixes the problem.
822	WP_ConvertKit()->get_class( 'admin_notices' )->add( 'authorization_failed' );
823
824	$settings = new ConvertKit_Settings();
825	$settings->delete_credentials();
826
827	}
828
829	// Update Access Token when refreshed by the API class.
830	add_action( 'convertkit_api_get_access_token', 'convertkit_maybe_update_credentials', 10, 2 );
831	add_action( 'convertkit_api_refresh_token', 'convertkit_maybe_update_credentials', 10, 2 );
832
833	// Delete credentials if the API class uses a invalid access token.
834	// This prevents the Plugin making repetitive API requests that will 401.
835	add_action( 'convertkit_api_access_token_invalid', 'convertkit_maybe_delete_credentials', 10, 2 );
836