convertkit / includes / functions.php

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

480 lines 10.3 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
21	// Check if we are on a multisite install, activating network wide, or a single install.
22	if ( ! is_multisite() \|\| ! $network_wide ) {
23	// Single Site activation.
24	$convertkit->get_class( 'setup' )->activate();
25
26	// Set a transient for 30 seconds to redirect to the setup screen on activation.
27	set_transient( 'convertkit-setup', true, 30 );
28	} else {
29	// Multisite network wide activation.
30	$sites = get_sites(
31	array(
32	'number' => 0,
33	)
34	);
35	foreach ( $sites as $site ) {
36	switch_to_blog( (int) $site->blog_id );
37	$convertkit->get_class( 'setup' )->activate();
38	restore_current_blog();
39	}
40	}
41
42	}
43
44	/**
45	* Runs the activation and update routines when the plugin is activated
46	* on a WordPress multisite setup.
47	*
48	* @since 1.9.7.4
49	*
50	* @param WP_Site\|int $site_or_blog_id WP_Site or Blog ID.
51	*/
52	function convertkit_plugin_activate_new_site( $site_or_blog_id ) {
53
54	// Check if $site_or_blog_id is a WP_Site or a blog ID.
55	if ( is_a( $site_or_blog_id, 'WP_Site' ) ) {
56	$site_or_blog_id = $site_or_blog_id->blog_id;
57	}
58
59	// Initialise Plugin.
60	$convertkit = WP_ConvertKit();
61
62	// Run installation routine.
63	switch_to_blog( $site_or_blog_id );
64	$convertkit->get_class( 'setup' )->activate();
65	restore_current_blog();
66
67	}
68
69	/**
70	* Runs the deactivation routine when the plugin is deactivated.
71	*
72	* @since 1.9.7.4
73	*
74	* @param bool $network_wide Is network wide deactivation.
75	*/
76	function convertkit_plugin_deactivate( $network_wide ) {
77
78	// Initialise Plugin.
79	$convertkit = WP_ConvertKit();
80
81	// Check if we are on a multisite install, activating network wide, or a single install.
82	if ( ! is_multisite() \|\| ! $network_wide ) {
83	// Single Site activation.
84	$convertkit->get_class( 'setup' )->deactivate();
85	} else {
86	// Multisite network wide activation.
87	$sites = get_sites(
88	array(
89	'number' => 0,
90	)
91	);
92	foreach ( $sites as $site ) {
93	switch_to_blog( (int) $site->blog_id );
94	$convertkit->get_class( 'setup' )->deactivate();
95	restore_current_blog();
96	}
97	}
98
99	}
100
101	/**
102	* Helper method to get supported Post Types.
103	*
104	* @since 1.9.6
105	*
106	* @return array Post Types
107	*/
108	function convertkit_get_supported_post_types() {
109
110	$post_types = array(
111	'page',
112	'post',
113	);
114
115	/**
116	* Defines the Post Types that support ConvertKit Forms.
117	*
118	* @since 1.9.6
119	*
120	* @param array $post_types Post Types
121	*/
122	$post_types = apply_filters( 'convertkit_get_supported_post_types', $post_types );
123
124	return $post_types;
125
126	}
127
128	/**
129	* Helper method to get supported Post Types for Restricted Content (Member's Content)
130	*
131	* @since 2.1.0
132	*
133	* @return array Post Types
134	*/
135	function convertkit_get_supported_restrict_content_post_types() {
136
137	$post_types = array(
138	'page',
139	'post',
140	);
141
142	/**
143	* Defines the Post Types that support Restricted Content / Members Content functionality.
144	*
145	* @since 2.0.0
146	*
147	* @param array $post_types Post Types
148	*/
149	$post_types = apply_filters( 'convertkit_get_supported_restrict_content_post_types', $post_types );
150
151	return $post_types;
152
153	}
154
155	/**
156	* Helper method to get registered Shortcodes.
157	*
158	* @since 1.9.6.5
159	*
160	* @return array Shortcodes
161	*/
162	function convertkit_get_shortcodes() {
163
164	$shortcodes = array();
165
166	/**
167	* Registers shortcodes for the ConvertKit Plugin.
168	*
169	* @since 1.9.6.5
170	*
171	* @param array $shortcodes Shortcodes
172	*/
173	$shortcodes = apply_filters( 'convertkit_shortcodes', $shortcodes );
174
175	return $shortcodes;
176
177	}
178
179	/**
180	* Helper method to get registered Blocks.
181	*
182	* @since 1.9.6
183	*
184	* @return array Blocks
185	*/
186	function convertkit_get_blocks() {
187
188	$blocks = array();
189
190	/**
191	* Registers blocks for the ConvertKit Plugin.
192	*
193	* @since 1.9.6
194	*
195	* @param array $blocks Blocks
196	*/
197	$blocks = apply_filters( 'convertkit_blocks', $blocks );
198
199	return $blocks;
200
201	}
202
203	/**
204	* Helper method to get registered Block formatters for Gutenberg.
205	*
206	* @since 2.2.0
207	*
208	* @return array Block formatters
209	*/
210	function convertkit_get_block_formatters() {
211
212	$block_formatters = array();
213
214	/**
215	* Registers block formatters in Gutenberg for the ConvertKit Plugin.
216	*
217	* @since 2.2.0
218	*
219	* @param array $block_formatters Block formatters.
220	*/
221	$block_formatters = apply_filters( 'convertkit_get_block_formatters', $block_formatters );
222
223	return $block_formatters;
224
225	}
226
227	/**
228	* Helper method to return the Plugin Settings Link
229	*
230	* @since 1.9.6
231	*
232	* @param array $query_args Optional Query Args.
233	* @return string Settings Link
234	*/
235	function convertkit_get_settings_link( $query_args = array() ) {
236
237	$query_args = array_merge(
238	$query_args,
239	array(
240	'page' => '_wp_convertkit_settings',
241	)
242	);
243
244	return add_query_arg( $query_args, admin_url( 'options-general.php' ) );
245
246	}
247
248	/**
249	* Helper method to return the Plugin Settings Link
250	*
251	* @since 2.2.4
252	*
253	* @param array $query_args Optional Query Args.
254	* @return string Settings Link
255	*/
256	function convertkit_get_setup_wizard_plugin_link( $query_args = array() ) {
257
258	$query_args = array_merge(
259	$query_args,
260	array(
261	'page' => 'convertkit-setup',
262	)
263	);
264
265	return add_query_arg( $query_args, admin_url( 'options.php' ) );
266
267	}
268
269	/**
270	* Helper method to return the URL the user needs to visit to register a ConvertKit account.
271	*
272	* @since 1.9.8.4
273	*
274	* @return string ConvertKit Registration URL.
275	*/
276	function convertkit_get_registration_url() {
277
278	return add_query_arg(
279	array(
280	'utm_source' => 'wordpress',
281	'utm_term' => get_locale(),
282	'utm_content' => 'convertkit',
283	),
284	'https://app.convertkit.com/users/signup'
285	);
286
287	}
288
289	/**
290	* Helper method to return the URL the user needs to visit to sign in to their ConvertKit account.
291	*
292	* @since 1.9.6.1
293	*
294	* @return string ConvertKit Login URL.
295	*/
296	function convertkit_get_sign_in_url() {
297
298	return add_query_arg(
299	array(
300	'utm_source' => 'wordpress',
301	'utm_term' => get_locale(),
302	'utm_content' => 'convertkit',
303	),
304	'https://app.convertkit.com/'
305	);
306
307	}
308
309	/**
310	* Helper method to return the URL the user needs to visit to manage thier billing.
311	*
312	* @since 2.2.7
313	*
314	* @return string ConvertKit Billing URL.
315	*/
316	function convertkit_get_billing_url() {
317
318	return add_query_arg(
319	array(
320	'utm_source' => 'wordpress',
321	'utm_term' => get_locale(),
322	'utm_content' => 'convertkit',
323	),
324	'https://app.convertkit.com/account_settings/billing/'
325	);
326
327	}
328
329	/**
330	* Helper method to return the URL the user needs to visit on the ConvertKit app to obtain their API Key and Secret.
331	*
332	* @since 1.9.6.1
333	*
334	* @return string ConvertKit App URL.
335	*/
336	function convertkit_get_api_key_url() {
337
338	return add_query_arg(
339	array(
340	'utm_source' => 'wordpress',
341	'utm_term' => get_locale(),
342	'utm_content' => 'convertkit',
343	),
344	'https://app.convertkit.com/account_settings/advanced_settings/'
345	);
346
347	}
348
349	/**
350	* Helper method to return the URL the user needs to visit on the ConvertKit app to create a new Form or Landing Page.
351	*
352	* @since 2.2.3
353	*
354	* @return string ConvertKit App URL
355	*/
356	function convertkit_get_new_form_url() {
357
358	return add_query_arg(
359	array(
360	'utm_source' => 'wordpress',
361	'utm_term' => get_locale(),
362	'utm_content' => 'convertkit',
363	),
364	'https://app.convertkit.com/forms/new/'
365	);
366
367	}
368
369	/**
370	* Helper method to return the URL the user needs to visit to edit ConvertKit forms.
371	*
372	* @since 2.2.3
373	*
374	* @return string ConvertKit Form Editor URL.
375	*/
376	function convertkit_get_form_editor_url() {
377
378	return add_query_arg(
379	array(
380	'utm_source' => 'wordpress',
381	'utm_term' => get_locale(),
382	'utm_content' => 'convertkit',
383	),
384	'https://app.convertkit.com/forms'
385	);
386
387	}
388
389	/**
390	* Helper method to return the URL the user needs to visit on the ConvertKit app to create a new Broadcast.
391	*
392	* @since 2.2.6
393	*
394	* @return string ConvertKit App URL.
395	*/
396	function convertkit_get_new_broadcast_url() {
397
398	return add_query_arg(
399	array(
400	'utm_source' => 'wordpress',
401	'utm_term' => get_locale(),
402	'utm_content' => 'convertkit',
403	),
404	'https://app.convertkit.com/campaigns/'
405	);
406
407	}
408
409	/**
410	* Helper method to return the URL the user needs to visit on the ConvertKit app to create a new Product.
411	*
412	* @since 2.2.3
413	*
414	* @return string ConvertKit App URL.
415	*/
416	function convertkit_get_new_product_url() {
417
418	return add_query_arg(
419	array(
420	'utm_source' => 'wordpress',
421	'utm_term' => get_locale(),
422	'utm_content' => 'convertkit',
423	),
424	'https://app.convertkit.com/products/new/'
425	);
426
427	}
428
429	/**
430	* Helper method to enqueue Select2 scripts for use within the ConvertKit Plugin.
431	*
432	* @since 1.9.6.4
433	*/
434	function convertkit_select2_enqueue_scripts() {
435
436	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 );
437	wp_enqueue_script( 'convertkit-admin-select2', CONVERTKIT_PLUGIN_URL . 'resources/backend/js/select2.js', array( 'convertkit-select2' ), CONVERTKIT_PLUGIN_VERSION, false );
438
439	}
440
441	/**
442	* Helper method to enqueue Select2 stylesheets for use within the ConvertKit Plugin.
443	*
444	* @since 1.9.6.4
445	*/
446	function convertkit_select2_enqueue_styles() {
447
448	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 );
449	wp_enqueue_style( 'convertkit-admin-select2', CONVERTKIT_PLUGIN_URL . 'resources/backend/css/select2.css', array(), CONVERTKIT_PLUGIN_VERSION );
450
451	}
452
453	/**
454	* Return the contents of the given local file.
455	*
456	* @since 2.2.2
457	*
458	* @param string $local_file Local file, including path.
459	* @return string File contents.
460	*/
461	function convertkit_get_file_contents( $local_file ) {
462
463	// Bail if the file doesn't exist.
464	if ( ! file_exists( $local_file ) ) {
465	return '';
466	}
467
468	// Read file.
469	$contents = file_get_contents( $local_file ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents
470
471	// Return an empty string if the contents of the file could not be read.
472	if ( ! $contents ) {
473	return '';
474	}
475
476	// Return file's contents.
477	return $contents;
478
479	}
480