actions.php — GiveWP – Donation Plugin and Fundraising Platform 4.2.1

give / includes / actions.php

give / includes Last commit date

actions.php

354 lines

1	<?php
2	/**
3	* Front-end Actions
4	*
5	* @package Give
6	* @subpackage Functions
7	* @copyright Copyright (c) 2016, GiveWP
8	* @license https://opensource.org/licenses/gpl-license GNU Public License
9	* @since 1.0
10	*/
11
12	// Exit if accessed directly.
13	if ( ! defined( 'ABSPATH' ) ) {
14	exit;
15	}
16
17
18	/**
19	* Look for Give core add-ons update after every third day
20	*
21	* @since 2.5.11
22	*/
23	Give_Cron::add_thricely_event( 'give_refresh_licenses' );
24
25	/**
26	* Hooks Give actions, when present in the $_GET superglobal. Every give_action
27	* present in $_GET is called using WordPress's do_action function. These
28	* functions are called on init.
29	*
30	* @since 1.0
31	*
32	* @return void
33	*/
34	function give_get_actions() {
35
36	$get_data = give_clean( $_GET ); // WPCS: input var ok, sanitization ok, CSRF ok.
37
38	$_get_action = ! empty( $get_data['give_action'] ) ? $get_data['give_action'] : null;
39
40	// Add backward compatibility to give-action param ( $_GET ).
41	if ( empty( $_get_action ) ) {
42	$_get_action = ! empty( $get_data['give-action'] ) ? $get_data['give-action'] : null;
43	}
44
45	if ( isset( $_get_action ) ) {
46	/**
47	* Fires in WordPress init or admin init, when give_action is present in $_GET.
48	*
49	* @since 1.0
50	*
51	* @param array $_GET Array of HTTP GET variables.
52	*/
53	do_action( "give_{$_get_action}", $get_data );
54	}
55
56	}
57
58	add_action( 'init', 'give_get_actions' );
59
60	/**
61	* Hooks Give actions, when present in the $_POST super global. Every give_action
62	* present in $_POST is called using WordPress's do_action function. These
63	* functions are called on init.
64	*
65	* @since 1.0
66	*
67	* @return void
68	*/
69	function give_post_actions() {
70
71	$post_data = give_clean( $_POST ); // WPCS: input var ok, sanitization ok, CSRF ok.
72
73	$_post_action = ! empty( $post_data['give_action'] ) ? $post_data['give_action'] : null;
74
75	// Add backward compatibility to give-action param ( $_POST ).
76	if ( empty( $_post_action ) ) {
77	$_post_action = ! empty( $post_data['give-action'] ) ? $post_data['give-action'] : null;
78	}
79
80	if ( isset( $_post_action ) ) {
81	/**
82	* Fires in WordPress init or admin init, when give_action is present in $_POST.
83	*
84	* @since 1.0
85	*
86	* @param array $_POST Array of HTTP POST variables.
87	*/
88	do_action( "give_{$_post_action}", $post_data );
89	}
90
91	}
92
93	add_action( 'init', 'give_post_actions' );
94
95	/**
96	* Connect WordPress user with Donor.
97	*
98	* @param int $user_id User ID.
99	* @param array $user_data User Data.
100	*
101	* @since 1.7
102	*
103	* @return void
104	*/
105	function give_connect_donor_to_wpuser( $user_id, $user_data ) {
106	/* @var Give_Donor $donor */
107	$donor = new Give_Donor( $user_data['user_email'] );
108
109	// Validate donor id and check if do nor is already connect to wp user or not.
110	if ( $donor->id && ! $donor->user_id ) {
111
112	// Update donor user_id.
113	if ( $donor->update( [ 'user_id' => $user_id ] ) ) {
114	$donor_note = sprintf( esc_html__( 'WordPress user #%1$d is connected to #%2$d', 'give' ), $user_id, $donor->id );
115	$donor->add_note( $donor_note );
116
117	// Update user_id meta in payments.
118	// if( ! empty( $donor->payment_ids ) && ( $donations = explode( ',', $donor->payment_ids ) ) ) {
119	// foreach ( $donations as $donation ) {
120	// give_update_meta( $donation, '_give_payment_user_id', $user_id );
121	// }
122	// }
123	// Do not need to update user_id in payment because we will get user id from donor id now.
124	}
125	}
126	}
127
128	add_action( 'give_insert_user', 'give_connect_donor_to_wpuser', 10, 2 );
129
130
131	/**
132	* Processing after donor batch export complete
133	*
134	* @since 1.8
135	*
136	* @param $data
137	*/
138	function give_donor_batch_export_complete( $data ) {
139	// Remove donor ids cache.
140	if (
141	isset( $data['class'] )
142	&& 'Give_Batch_Donors_Export' === $data['class']
143	&& ! empty( $data['forms'] )
144	&& isset( $data['give_export_option']['query_id'] )
145	) {
146	Give_Cache::delete( Give_Cache::get_key( $data['give_export_option']['query_id'] ) );
147	}
148	}
149
150	add_action( 'give_file_export_complete', 'give_donor_batch_export_complete' );
151
152
153	/**
154	* Set Donation Amount for Multi Level Donation Forms
155	*
156	* @param int $form_id Donation Form ID.
157	*
158	* @since 1.8.9
159	*
160	* @return void
161	*/
162	function give_set_donation_levels_max_min_amount( $form_id ) {
163	if (
164	( 'set' === $_POST['_give_price_option'] ) \|\|
165	( in_array( '_give_donation_levels', $_POST ) && count( $_POST['_give_donation_levels'] ) <= 0 ) \|\|
166	! ( $donation_levels_amounts = wp_list_pluck( $_POST['_give_donation_levels'], '_give_amount' ) )
167	) {
168	// Delete old meta.
169	give_delete_meta( $form_id, '_give_levels_minimum_amount' );
170	give_delete_meta( $form_id, '_give_levels_maximum_amount' );
171
172	return;
173	}
174
175	// Sanitize donation level amounts.
176	$donation_levels_amounts = array_map( 'give_maybe_sanitize_amount', $donation_levels_amounts );
177
178	$min_amount = min( $donation_levels_amounts );
179	$max_amount = max( $donation_levels_amounts );
180
181	// Set Minimum and Maximum amount for Multi Level Donation Forms.
182	give_update_meta( $form_id, '_give_levels_minimum_amount', $min_amount ? give_sanitize_amount_for_db( $min_amount ) : 0 );
183	give_update_meta( $form_id, '_give_levels_maximum_amount', $max_amount ? give_sanitize_amount_for_db( $max_amount ) : 0 );
184	}
185
186	add_action( 'give_pre_process_give_forms_meta', 'give_set_donation_levels_max_min_amount', 30 );
187
188
189	/**
190	* Save donor address when donation complete
191	*
192	* @since 2.0
193	*
194	* @param int $payment_id
195	*/
196	function _give_save_donor_billing_address( $payment_id ) {
197	$donor_id = absint( give_get_payment_donor_id( $payment_id ) );
198
199	// Bailout
200	if ( ! $donor_id ) {
201	return;
202	}
203
204	/* @var Give_Donor $donor */
205	$donor = new Give_Donor( $donor_id );
206
207	// Save address.
208	$donor->add_address( 'billing[]', give_get_donation_address( $payment_id ) );
209	}
210
211	add_action( 'give_complete_donation', '_give_save_donor_billing_address', 9999 );
212
213	/**
214	* Verify addon dependency before addon update
215	*
216	* @since 4.1.0 add bailout for GiveWP to protect it from licensing issues
217	* @since 2.1.4
218	*
219	* @param $error
220	* @param $hook_extra
221	*
222	* @return WP_Error
223	*/
224	function __give_verify_addon_dependency_before_update( $error, $hook_extra ) {
225	// Bailout.
226	if (
227	is_wp_error( $error )
228	\|\| ! array_key_exists( 'plugin', $hook_extra )
229	) {
230	return $error;
231	}
232
233	// If the plugin is GiveWP then bypass the License check altogether. If there's a problem with licensing it's
234	// important that we can always upgrade GiveWP.
235	$plugin_base = strtolower( $hook_extra['plugin'] );
236	if ( GIVE_PLUGIN_BASENAME === $plugin_base ) {
237	return $error;
238	}
239
240	$licensed_addon = array_map( 'strtolower', Give_License::get_licensed_addons() );
241
242	// Skip if not a Give addon.
243	if ( ! in_array( $plugin_base, $licensed_addon ) ) {
244	return $error;
245	}
246
247	// Load file.
248	if ( ! class_exists( 'Give_Readme_Parser' ) ) {
249	require_once GIVE_PLUGIN_DIR . 'includes/class-give-readme-parser.php';
250	}
251
252	$plugin_base = strtolower( $plugin_base );
253	$plugin_slug = str_replace( '.php', '', basename( $plugin_base ) );
254
255	$url = give_get_addon_readme_url( $plugin_slug );
256
257	$parser = new Give_Readme_Parser( $url );
258	$give_min_version = $parser->requires_at_least();
259
260	if ( version_compare( GIVE_VERSION, $give_min_version, '<' ) ) {
261	return new WP_Error(
262	'Give_Addon_Update_Error',
263	sprintf(
264	__( 'GiveWP version %s is required to update this add-on.', 'give' ),
265	$give_min_version
266	)
267	);
268	}
269
270	return $error;
271	}
272
273	add_filter( 'upgrader_pre_install', '__give_verify_addon_dependency_before_update', 10, 2 );
274
275	/**
276	* Function to add suppress_filters param if WPML add-on is activated.
277	*
278	* @since 2.1.4
279	*
280	* @param array WP query argument for Total Goal.
281	*
282	* @return array WP query argument for Total Goal.
283	*/
284	function __give_wpml_total_goal_shortcode_agrs( $args ) {
285	$args['suppress_filters'] = true;
286
287	return $args;
288	}
289
290	/**
291	* Function to remove WPML post where filter in goal total amount shortcode.
292	*
293	* @since 2.1.4
294	* @global SitePress $sitepress
295	*/
296	function __give_remove_wpml_parse_query_filter() {
297	global $sitepress;
298	remove_action( 'parse_query', [ $sitepress, 'parse_query' ] );
299	}
300
301
302	/**
303	* Function to add WPML post where filter in goal total amount shortcode.
304	*
305	* @since 2.1.4
306	* @global SitePress $sitepress
307	*/
308	function __give_add_wpml_parse_query_filter() {
309	global $sitepress;
310	add_action( 'parse_query', [ $sitepress, 'parse_query' ] );
311	}
312
313	/**
314	* Action all the hook that add support for WPML.
315	*
316	* @since 2.1.4
317	*/
318	function give_add_support_for_wpml() {
319	if ( ! function_exists( 'is_plugin_active' ) ) {
320	include_once ABSPATH . 'wp-admin/includes/plugin.php';
321	}
322
323	if ( is_plugin_active( 'sitepress-multilingual-cms/sitepress.php' ) ) {
324
325	add_filter( 'give_totals_goal_shortcode_query_args', '__give_wpml_total_goal_shortcode_agrs' );
326
327	// @see https://wpml.org/forums/topic/problem-with-query-filter-in-get_posts-function/#post-271309
328	add_action( 'give_totals_goal_shortcode_before_render', '__give_remove_wpml_parse_query_filter', 99 );
329	add_action( 'give_totals_goal_shortcode_after_render', '__give_add_wpml_parse_query_filter', 99 );
330	}
331	}
332
333	add_action( 'give_init', 'give_add_support_for_wpml', 1000 );
334
335	/**
336	* Backward compatibility for email_access property
337	* Note: only for internal purpose
338	*
339	* @todo: Need to decide when to remove this backward compatibility.
340	* We decided to load Give()->email_access on for frontend but some of email tags is still using this. Since we have option to resend email in admin then
341	* this cause of fatal error because that property does not load in backend. This is a temporary solution to prevent fatal error when resend receipt.
342	* ref: https://github.com/impress-org/give/issues/4068
343	*
344	* @since 2.4.5
345	*/
346	function give_set_email_access_property() {
347	if ( ! ( Give()->email_access instanceof Give_Email_Access ) ) {
348	require_once GIVE_PLUGIN_DIR . 'includes/class-give-email-access.php';
349	Give()->email_access = new Give_Email_Access();
350	}
351	}
352	add_action( 'give_email_links', 'give_set_email_access_property', -1 );
353	add_action( 'give_donation-receipt_email_notification', 'give_set_email_access_property', -1 );
354