give / includes / emails / functions.php

functions.php in GiveWP – Donation Plugin and Fundraising Platform 2.3.1, at includes/emails/functions.php

274 lines 9.2 KB

Raw Download Zip

1	<?php
2	/**
3	* Email Functions
4	*
5	* @package Give
6	* @subpackage Emails
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	* Email Donation Receipt.
19	*
20	* Email the donation confirmation to the donor via the customizable "Donation Receipt" settings.
21	*
22	* @since 1.0
23	*
24	* @param int $payment_id Payment ID.
25	* @param bool $admin_notice Whether to send the admin email notification or not (default: true).
26	*
27	* @return void
28	*/
29	function give_email_donation_receipt( $payment_id, $admin_notice = true ) {
30	/**
31	* Fire the action
32	*/
33	do_action( 'give_donation-receipt_email_notification', $payment_id );
34
35	// If admin notifications are on, send the admin notice.
36	if ( $admin_notice && give_is_setting_enabled( Give_Email_Notification::get_instance('new-donation' )->get_notification_status() ) ) {
37	/**
38	* Fires in the donation email receipt.
39	*
40	* When admin email notices are not disabled, you can add new email notices.
41	*
42	* @since 1.0
43	*
44	* @param int $payment_id Payment id.
45	* @param mixed $payment_data Payment meta data.
46	*/
47	do_action( 'give_new-donation_email_notification', $payment_id, give_get_payment_meta( $payment_id ) );
48	}
49	}
50
51	/**
52	* Sends the Admin Sale Notification Email
53	*
54	* @since 1.0
55	*
56	* @param int $payment_id Payment ID (default: 0)
57	*
58	* @return void
59	*/
60	function give_admin_email_notice( $payment_id ) {
61	/**
62	* Fires in the donation email receipt.
63	*
64	* When admin email notices are not disabled, you can add new email notices.
65	*
66	* @since 1.0
67	*
68	* @param int $payment_id Payment id.
69	* @param mixed $payment_data Payment meta data.
70	*/
71	do_action( 'give_new-donation_email_notification', $payment_id );
72	}
73
74	add_action( 'give_admin_donation_email', 'give_admin_email_notice' );
75
76
77	/**
78	* Get default donation notification email text
79	*
80	* Returns the stored email text if available, the standard email text if not
81	*
82	* @since 1.0
83	* @return string $message
84	*/
85	function give_get_default_donation_notification_email() {
86
87	$default_email_body = __( 'Hi there,', 'give' ) . "\n\n";
88	$default_email_body .= __( 'This email is to inform you that a new donation has been made on your website:', 'give' ) . ' {site_url}' . ".\n\n";
89	$default_email_body .= '<strong>' . __( 'Donor:', 'give' ) . '</strong> {name}' . "\n";
90	$default_email_body .= '<strong>' . __( 'Donation:', 'give' ) . '</strong> {donation}' . "\n";
91	$default_email_body .= '<strong>' . __( 'Amount:', 'give' ) . '</strong> {amount}' . "\n";
92	$default_email_body .= '<strong>' . __( 'Payment Method:', 'give' ) . '</strong> {payment_method}' . "\n\n";
93	$default_email_body .= __( 'Thank you,', 'give' ) . "\n\n";
94	$default_email_body .= '{sitename}' . "\n";
95
96	return apply_filters( 'give_default_donation_notification_email', $default_email_body );
97	}
98
99
100	/**
101	* Get default donation receipt email text
102	*
103	* Returns the stored email text if available, the standard email text if not
104	*
105	* @since 1.3.7
106	* @return string $message
107	*/
108	function give_get_default_donation_receipt_email() {
109
110	$default_email_body = __( 'Dear', 'give' ) . " {name},\n\n";
111	$default_email_body .= __( 'Thank you for your donation. Your generosity is appreciated! Here are the details of your donation:', 'give' ) . "\n\n";
112	$default_email_body .= '<strong>' . __( 'Donor:', 'give' ) . '</strong> {fullname}' . "\n";
113	$default_email_body .= '<strong>' . __( 'Donation:', 'give' ) . '</strong> {donation}' . "\n";
114	$default_email_body .= '<strong>' . __( 'Donation Date:', 'give' ) . '</strong> {date}' . "\n";
115	$default_email_body .= '<strong>' . __( 'Amount:', 'give' ) . '</strong> {amount}' . "\n";
116	$default_email_body .= '<strong>' . __( 'Payment Method:', 'give' ) . '</strong> {payment_method}' . "\n";
117	$default_email_body .= '<strong>' . __( 'Payment ID:', 'give' ) . '</strong> {payment_id}' . "\n\n";
118	$default_email_body .= '{receipt_link}' . "\n\n";
119	$default_email_body .= "\n\n";
120	$default_email_body .= __( 'Sincerely,', 'give' ) . "\n";
121	$default_email_body .= '{sitename}' . "\n";
122
123	return apply_filters( 'give_default_donation_receipt_email', $default_email_body );
124	}
125
126	/**
127	* Get various correctly formatted names used in emails
128	*
129	* @since 1.0
130	*
131	* @param array $user_info List of User Information.
132	* @param Give_Payment\|bool $payment Payment Object.
133	*
134	* @return array $email_names
135	*/
136	function give_get_email_names( $user_info, $payment = false ) {
137	$email_names = array();
138
139	if ( is_a( $payment, 'Give_Payment' ) ) {
140
141	if ( $payment->user_id > 0 ) {
142
143	$user_data = get_userdata( $payment->user_id );
144	$email_names['name'] = $payment->first_name;
145	$email_names['fullname'] = trim( $payment->first_name . ' ' . $payment->last_name );
146	$email_names['username'] = $user_data->user_login;
147
148	} elseif ( ! empty( $payment->first_name ) ) {
149
150	$email_names['name'] = $payment->first_name;
151	$email_names['fullname'] = trim( $payment->first_name . ' ' . $payment->last_name );
152	$email_names['username'] = $payment->first_name;
153
154	} else {
155
156	$email_names['name'] = $payment->email;
157	$email_names['username'] = $payment->email;
158
159	}
160	} else {
161
162	// Support for old serialized data.
163	if ( is_serialized( $user_info ) ) {
164
165	// Security check.
166	preg_match( '/[oO]\s:\s\d+\s:\s"\s*(?!(?i)(stdClass))/', $user_info, $matches );
167	if ( ! empty( $matches ) ) {
168	return array(
169	'name' => '',
170	'fullname' => '',
171	'username' => '',
172	);
173	} else {
174	$user_info = maybe_unserialize( $user_info );
175	}
176	}
177
178	if ( isset( $user_info['id'] ) && $user_info['id'] > 0 && isset( $user_info['first_name'] ) ) {
179	$user_data = get_userdata( $user_info['id'] );
180	$email_names['name'] = $user_info['first_name'];
181	$email_names['fullname'] = $user_info['first_name'] . ' ' . $user_info['last_name'];
182	$email_names['username'] = $user_data->user_login;
183	} elseif ( isset( $user_info['first_name'] ) ) {
184	$email_names['name'] = $user_info['first_name'];
185	$email_names['fullname'] = $user_info['first_name'] . ' ' . $user_info['last_name'];
186	$email_names['username'] = $user_info['first_name'];
187	} else {
188	$email_names['name'] = $user_info['email'];
189	$email_names['username'] = $user_info['email'];
190	}
191	} // End if().
192
193	// Set title prefix to name, if non empty.
194	if ( ! empty( $user_info['title'] ) && ! empty( $user_info['last_name'] ) ) {
195	$email_names['name'] = give_get_donor_name_with_title_prefixes( $user_info['title'], $user_info['last_name'] );
196	}
197
198	// Set title prefix to fullname, if non empty.
199	if ( ! empty( $user_info['title'] ) && ! empty( $email_names['fullname'] ) ) {
200	$email_names['fullname'] = give_get_donor_name_with_title_prefixes( $user_info['title'], $email_names['fullname'] );
201	}
202
203	return $email_names;
204	}
205
206	/**
207	* Send email to admin when user tries to login and restricted due to user - donor disconnection.
208	*
209	* @param int $user_id User ID.
210	* @param int $donor_id Donor ID.
211	*
212	* @since 1.8.14
213	*/
214	function give_admin_email_user_donor_disconnection( $user_id, $donor_id ) {
215
216	$user_id = absint( $user_id );
217	$donor_id = absint( $donor_id );
218
219	// Bail Out, if user id doesn't exists.
220	if ( empty( $user_id ) ) {
221	return;
222	}
223
224	// Bail Out, if donor id doesn't exists.
225	if ( empty( $donor_id ) ) {
226	return;
227	}
228
229	$from_name = give_get_option( 'from_name', wp_specialchars_decode( get_bloginfo( 'name' ), ENT_QUOTES ) );
230
231	$from_email = give_get_option( 'from_email', get_bloginfo( 'admin_email' ) );
232
233	/* translators: %s: payment id */
234	$subject = __( 'Attention: User tries to login whose Donor profile is disconnected!', 'give' );
235
236	/**
237	* Filters the Donor-User Disconnection notification subject.
238	*
239	* @since 1.8.14
240	*/
241	$subject = apply_filters( 'give_admin_donor_user_disconnection_notification_subject', wp_strip_all_tags( $subject ) );
242
243	$headers = "From: " . stripslashes_deep( html_entity_decode( $from_name, ENT_COMPAT, 'UTF-8' ) ) . " <$from_email>\r\n";
244	$headers .= "Reply-To: " . $from_email . "\r\n";
245	$headers .= "Content-Type: text/html; charset=utf-8\r\n";
246
247	/**
248	* Filters the Donor-User Disconnection notification email headers.
249	*
250	* @since 1.8.14
251	*/
252	$headers = apply_filters( 'give_admin_donor_user_disconnection_notification_headers', $headers );
253
254	$message = __( 'Hi Admin,', 'give' ) . "\n\n";
255	$message .= __( 'This email is to inform you that a user has tried logging in. But, User was unable to login due to User-Donor profile disconnection.', 'give' ) . "\n\n";
256	$message .= __( 'Do you want to reconnect User and Donor profile again?', 'give' ) . "\n\n";
257	$message .= sprintf(
258	'<a href="%1$s">%2$s</a>',
259	esc_url( admin_url() . 'edit.php?post_type=give_forms&page=give-donors&view=overview&id=' . $donor_id . '&user_id=' . $user_id . '&give-messages[]=reconnect-user' ),
260	__( 'Reconnect User', 'give' ) . "\n\n"
261	);
262	$message .= __( 'Thank you,', 'give' ) . "\n\n";
263	$message .= '{sitename}' . "\n";
264
265	$emails = Give()->emails;
266	$emails->__set( 'from_name', $from_name );
267	$emails->__set( 'from_email', $from_email );
268	$emails->__set( 'headers', $headers );
269	$emails->__set( 'heading', __( 'User - Donor Profile Disconnection', 'give' ) );
270
271	$emails->send( give_get_admin_notice_emails(), $subject, give_do_email_tags( $message ) );
272
273	}
274