← All changes | includes/functions.php +479 -30 2.2.2 → 3.1.9 View file →

		@@ -16,8 +16,9 @@
16	16	function convertkit_plugin_activate( $network_wide ) {
17	17
18	18	// Initialise Plugin.
19	19	$convertkit = WP_ConvertKit();
	20	+ $convertkit->initialize();
20	21
21	22	// Check if we are on a multisite install, activating network wide, or a single install.
22	23	if ( ! is_multisite() || ! $network_wide ) {
23	24	// Single Site activation.
		@@ -57,8 +58,9 @@
57	58	}
58	59
59	60	// Initialise Plugin.
60	61	$convertkit = WP_ConvertKit();
	62	+ $convertkit->initialize();
61	63
62	64	// Run installation routine.
63	65	switch_to_blog( $site_or_blog_id );
64	66	$convertkit->get_class( 'setup' )->activate();
		@@ -76,8 +78,9 @@
76	78	function convertkit_plugin_deactivate( $network_wide ) {
77	79
78	80	// Initialise Plugin.
79	81	$convertkit = WP_ConvertKit();
	82	+ $convertkit->initialize();
80	83
81	84	// Check if we are on a multisite install, activating network wide, or a single install.
82	85	if ( ! is_multisite() || ! $network_wide ) {
83	86	// Single Site activation.
		@@ -106,13 +109,32 @@
106	109	* @return array Post Types
107	110	*/
108	111	function convertkit_get_supported_post_types() {
109	112
	113	+ // Define supported Post Types.
110	114	$post_types = array(
111	115	'page',
112	116	'post',
113	117	);
114	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	+
115	137	/**
116	138	* Defines the Post Types that support ConvertKit Forms.
117	139	*
118	140	* @since 1.9.6
		@@ -129,27 +151,16 @@
129	151	* Helper method to get supported Post Types for Restricted Content (Member's Content)
130	152	*
131	153	* @since 2.1.0
132	154	*
	155	+ * @deprecated 2.4.3 No longer used by internal code and not recommended. Use `convertkit_get_supported_post_types` instead.
	156	+ *
133	157	* @return array Post Types
134	158	*/
135	159	function convertkit_get_supported_restrict_content_post_types() {
136	160
137		- $post_types = array(
138		- 'page',
139		- );
	161	+ return convertkit_get_supported_post_types();
140	162
141		- /**
142		- * Defines the Post Types that support Restricted Content / Members Content functionality.
143		- *
144		- * @since 2.0.0
145		- *
146		- * @param array $post_types Post Types
147		- */
148		- $post_types = apply_filters( 'convertkit_get_supported_restrict_content_post_types', $post_types );
149		-
150		- return $post_types;
151		-
152	163	}
153	164
154	165	/**
155	166	* Helper method to get registered Shortcodes.
		@@ -223,8 +234,57 @@
223	234
224	235	}
225	236
226	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	+/**
227	287	* Helper method to return the Plugin Settings Link
228	288	*
229	289	* @since 1.9.6
230	290	*
		@@ -244,8 +304,29 @@
244	304
245	305	}
246	306
247	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	+/**
248	329	* Helper method to return the URL the user needs to visit to register a ConvertKit account.
249	330	*
250	331	* @since 1.9.8.4
251	332	*
		@@ -258,9 +339,9 @@
258	339	'utm_source' => 'wordpress',
259	340	'utm_term' => get_locale(),
260	341	'utm_content' => 'convertkit',
261	342	),
262		- 'https://app.convertkit.com/users/signup'
	343	+ 'https://app.kit.com/users/signup'
263	344	);
264	345
265	346	}
266	347
		@@ -278,21 +359,101 @@
278	359	'utm_source' => 'wordpress',
279	360	'utm_term' => get_locale(),
280	361	'utm_content' => 'convertkit',
281	362	),
282		- 'https://app.convertkit.com/'
	363	+ 'https://app.kit.com/'
283	364	);
284	365
285	366	}
286	367
287	368	/**
288		- * Helper method to return the URL the user needs to visit on the ConvertKit app to obtain their API Key and Secret.
	369	+ * Helper method to return the URL the user needs to visit to manage thier billing.
289	370	*
290		- * @since 1.9.6.1
	371	+ * @since 2.2.7
291	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	+ *
292	453	* @return string ConvertKit App URL.
293	454	*/
294		-function convertkit_get_api_key_url() {
	455	+function convertkit_get_new_tag_url() {
295	456
296	457	return add_query_arg(
297	458	array(
298	459	'utm_source' => 'wordpress',
		@@ -298,14 +459,78 @@
298	459	'utm_source' => 'wordpress',
299	460	'utm_term' => get_locale(),
300	461	'utm_content' => 'convertkit',
301	462	),
302		- 'https://app.convertkit.com/account_settings/advanced_settings/'
	463	+ 'https://app.kit.com/subscribers/'
303	464	);
304	465
305	466	}
306	467
307	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	+/**
308	533	* Helper method to enqueue Select2 scripts for use within the ConvertKit Plugin.
309	534	*
310	535	* @since 1.9.6.4
311	536	*/
		@@ -337,22 +562,246 @@
337	562	* @return string File contents.
338	563	*/
339	564	function convertkit_get_file_contents( $local_file ) {
340	565
341		- // Call globals.
342		- global $wp_filesystem;
	566	+ // Bail if the file doesn't exist.
	567	+ if ( ! file_exists( $local_file ) ) {
	568	+ return '';
	569	+ }
343	570
344		- // Load filesystem class.
345		- require_once ABSPATH . 'wp-admin/includes/file.php';
	571	+ // Read file.
	572	+ $contents = file_get_contents( $local_file ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents
346	573
347		- // Initiate.
348		- WP_Filesystem();
349		-
350		- // Bail if the file doesn't exist.
351		- if ( ! $wp_filesystem->exists( $local_file ) ) {
	574	+ // Return an empty string if the contents of the file could not be read.
	575	+ if ( ! $contents ) {
352	576	return '';
353	577	}
354	578
355	579	// Return file's contents.
356		- return $wp_filesystem->get_contents( $local_file );
	580	+ return $contents;
357	581
358	582	}
	583	+
	584	+/**
	585	+ * Returns a dropdown field commonly used for settings, comprising of:
	586	+ * - Do not subscribe
	587	+ * - Subscribe
	588	+ * - Subscribe to Form
	589	+ *
	590	+ * @since 2.5.2
	591	+ *
	592	+ * @param string $name Field name.
	593	+ * @param string $value Field value.
	594	+ * @param string $id Field ID attribute.
	595	+ * @param string $css_class Field CSS class(es).
	596	+ * @param string $context Resource context.
	597	+ * @param bool|array $additional_options Additional <option> key/value pairs.
	598	+ */
	599	+function convertkit_get_subscription_dropdown_field( $name, $value, $id, $css_class = '', $context = '', $additional_options = false ) { // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter
	600	+
	601	+ // Load resource classes.
	602	+ $forms = new ConvertKit_Resource_Forms( $context );
	603	+ $tags = new ConvertKit_Resource_Tags( $context );
	604	+ $sequences = new ConvertKit_Resource_Sequences( $context );
	605	+
	606	+ ob_start();
	607	+ include CONVERTKIT_PLUGIN_PATH . '/views/backend/subscription-dropdown-field.php';
	608	+ $output = trim( ob_get_clean() );
	609	+
	610	+ // Return output.
	611	+ return $output;
	612	+
	613	+}
	614	+
	615	+/**
	616	+ * Helper method to safely call get_current_screen(), returning false
	617	+ * if the function is not available or returns null.
	618	+ *
	619	+ * Otherwise returns the given WP_Screen property.
	620	+ *
	621	+ * @since 2.5.9
	622	+ *
	623	+ * @param string $property WP_Screen property to return.
	624	+ * @return bool|string
	625	+ */
	626	+function convertkit_get_current_screen( $property ) {
	627	+
	628	+ // Bail if we cannot determine the screen.
	629	+ if ( ! function_exists( 'get_current_screen' ) ) {
	630	+ return false;
	631	+ }
	632	+
	633	+ // Get screen.
	634	+ $screen = get_current_screen();
	635	+
	636	+ // Bail if the screen couldn't be determined.
	637	+ if ( is_null( $screen ) ) {
	638	+ return false;
	639	+ }
	640	+
	641	+ // Return property.
	642	+ return $screen->$property;
	643	+
	644	+}
	645	+
	646	+/**
	647	+ * Outputs the Intercom help widget script.
	648	+ *
	649	+ * @since 2.7.2
	650	+ */
	651	+function convertkit_output_intercom_messenger() {
	652	+
	653	+ ?>
	654	+ <script>
	655	+ const KIT_INTERCOM_APP_ID = 'e4n3xtxz';
	656	+ window.intercomSettings = {
	657	+ api_base: 'https://api-iam.intercom.io',
	658	+ app_id: KIT_INTERCOM_APP_ID
	659	+ };
	660	+ </script>
	661	+
	662	+ <script>
	663	+ (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);}}})();
	664	+ </script>
	665	+ <?php
	666	+
	667	+}
	668	+
	669	+/**
	670	+ * Checks if the given Theme is active.
	671	+ *
	672	+ * @since 3.1.4
	673	+ *
	674	+ * @param string $theme_name Theme name.
	675	+ * @return bool
	676	+ */
	677	+function convertkit_is_theme_active( $theme_name ) {
	678	+
	679	+ // Assume Theme isn't active if we can't detect it.
	680	+ if ( ! function_exists( 'wp_get_theme' ) ) {
	681	+ return false;
	682	+ }
	683	+
	684	+ // Check the Parent Theme if we're on a Child Theme.
	685	+ if ( wp_get_theme()->parent() ) {
	686	+ $theme = wp_get_theme()->parent();
	687	+ } else {
	688	+ $theme = wp_get_theme();
	689	+ }
	690	+
	691	+ return strtolower( $theme->get( 'Name' ) ) === strtolower( $theme_name );
	692	+
	693	+}
	694	+
	695	+/**
	696	+ * Returns permitted HTML output when using wp_kses( ..., convertkit_kses_allowed_html()).
	697	+ *
	698	+ * @since 2.8.5
	699	+ */
	700	+function convertkit_kses_allowed_html() {
	701	+
	702	+ // Get WordPress' permitted HTML elements.
	703	+ $elements = wp_kses_allowed_html( 'post' );
	704	+
	705	+ // Add form elements.
	706	+ $form_elements = array(
	707	+ 'input' => array(
	708	+ 'type' => true,
	709	+ 'id' => true,
	710	+ 'name' => true,
	711	+ 'class' => true,
	712	+ 'value' => true,
	713	+ 'checked' => true,
	714	+ 'min' => true,
	715	+ 'max' => true,
	716	+ 'step' => true,
	717	+ 'data-*' => true,
	718	+ ),
	719	+ 'select' => array(
	720	+ 'id' => true,
	721	+ 'name' => true,
	722	+ 'class' => true,
	723	+ 'size' => true,
	724	+ 'multiple' => true,
	725	+ 'data-*' => true,
	726	+ ),
	727	+ 'option' => array(
	728	+ 'value' => true,
	729	+ 'selected' => true,
	730	+ 'data-*' => true,
	731	+ ),
	732	+ 'optgroup' => array(
	733	+ 'label' => true,
	734	+ 'data-*' => true,
	735	+ ),
	736	+ 'label' => array(
	737	+ 'for' => true,
	738	+ ),
	739	+ );
	740	+
	741	+ return array_merge( $elements, $form_elements );
	742	+
	743	+}
	744	+
	745	+/**
	746	+ * Saves the new access token, refresh token and its expiry, and schedules
	747	+ * a WordPress Cron event to refresh the token on expiry.
	748	+ *
	749	+ * @since 3.1.1
	750	+ *
	751	+ * @param array $result New Access Token, Refresh Token and Expiry.
	752	+ * @param string $client_id OAuth Client ID used for the Access and Refresh Tokens.
	753	+ */
	754	+function convertkit_maybe_update_credentials( $result, $client_id ) {
	755	+
	756	+ // Don't save these credentials if they're not for this Client ID.
	757	+ // They're for another Kit Plugin that uses OAuth.
	758	+ if ( $client_id !== CONVERTKIT_OAUTH_CLIENT_ID ) {
	759	+ return;
	760	+ }
	761	+
	762	+ $settings = new ConvertKit_Settings();
	763	+ $settings->update_credentials( $result );
	764	+
	765	+}
	766	+
	767	+/**
	768	+ * Deletes the stored access token, refresh token and its expiry from the Plugin settings,
	769	+ * and clears any existing scheduled WordPress Cron event to refresh the token on expiry,
	770	+ * when either:
	771	+ * - The access token is invalid
	772	+ * - The access token expired, and refreshing failed
	773	+ *
	774	+ * @since 3.1.1
	775	+ *
	776	+ * @param WP_Error $result Error result.
	777	+ * @param string $client_id OAuth Client ID used for the Access and Refresh Tokens.
	778	+ */
	779	+function convertkit_maybe_delete_credentials( $result, $client_id ) {
	780	+
	781	+ // Don't save these credentials if they're not for this Client ID.
	782	+ // They're for another Kit Plugin that uses OAuth.
	783	+ if ( $client_id !== CONVERTKIT_OAUTH_CLIENT_ID ) {
	784	+ return;
	785	+ }
	786	+
	787	+ // If the error isn't a 401, don't delete credentials.
	788	+ // This could be e.g. a temporary network error, rate limit or similar.
	789	+ if ( $result->get_error_data( 'convertkit_api_error' ) !== 401 ) {
	790	+ return;
	791	+ }
	792	+
	793	+ // Persist an error notice in the WordPress Administration until the user fixes the problem.
	794	+ WP_ConvertKit()->get_class( 'admin_notices' )->add( 'authorization_failed' );
	795	+
	796	+ $settings = new ConvertKit_Settings();
	797	+ $settings->delete_credentials();
	798	+
	799	+}
	800	+
	801	+// Update Access Token when refreshed by the API class.
	802	+add_action( 'convertkit_api_get_access_token', 'convertkit_maybe_update_credentials', 10, 2 );
	803	+add_action( 'convertkit_api_refresh_token', 'convertkit_maybe_update_credentials', 10, 2 );
	804	+
	805	+// Delete credentials if the API class uses a invalid access token.
	806	+// This prevents the Plugin making repetitive API requests that will 401.
	807	+add_action( 'convertkit_api_access_token_invalid', 'convertkit_maybe_delete_credentials', 10, 2 );