paypal
4 years ago
stripe
3 years ago
actions.php
4 years ago
functions.php
4 years ago
manual.php
3 years ago
offline-donations.php
4 years ago
offline-donations.php
509 lines
| 1 | <?php |
| 2 | /** |
| 3 | * Offline Donations Gateway |
| 4 | * |
| 5 | * @package Give |
| 6 | * @subpackage Gateways |
| 7 | * @copyright Copyright (c) 2016, GiveWP |
| 8 | * @license https://opensource.org/licenses/gpl-license GNU Public License |
| 9 | * @since 1.0 |
| 10 | */ |
| 11 | |
| 12 | /** |
| 13 | * Add our payment instructions to the checkout |
| 14 | * |
| 15 | * @since 1.0 |
| 16 | * |
| 17 | * @param int $form_id Give form id. |
| 18 | * |
| 19 | * @return void |
| 20 | */ |
| 21 | function give_offline_payment_cc_form( $form_id ) { |
| 22 | // Get offline payment instruction. |
| 23 | $offline_instructions = give_get_offline_payment_instruction( $form_id, true ); |
| 24 | |
| 25 | ob_start(); |
| 26 | |
| 27 | /** |
| 28 | * Fires before the offline info fields. |
| 29 | * |
| 30 | * @since 1.0 |
| 31 | * |
| 32 | * @param int $form_id Give form id. |
| 33 | */ |
| 34 | do_action( 'give_before_offline_info_fields', $form_id ); |
| 35 | ?> |
| 36 | <fieldset class="no-fields" id="give_offline_payment_info"> |
| 37 | <?php echo stripslashes( $offline_instructions ); ?> |
| 38 | </fieldset> |
| 39 | <?php |
| 40 | /** |
| 41 | * Fires after the offline info fields. |
| 42 | * |
| 43 | * @since 1.0 |
| 44 | * |
| 45 | * @param int $form_id Give form id. |
| 46 | */ |
| 47 | do_action( 'give_after_offline_info_fields', $form_id ); |
| 48 | |
| 49 | echo ob_get_clean(); |
| 50 | } |
| 51 | |
| 52 | add_action( 'give_offline_cc_form', 'give_offline_payment_cc_form' ); |
| 53 | |
| 54 | /** |
| 55 | * Give Offline Billing Field |
| 56 | * |
| 57 | * @param $form_id |
| 58 | */ |
| 59 | function give_offline_billing_fields( $form_id ) { |
| 60 | // Enable Default CC fields (billing info) |
| 61 | $post_offline_cc_fields = give_get_meta( $form_id, '_give_offline_donation_enable_billing_fields_single', true ); |
| 62 | $post_offline_customize_option = give_get_meta( $form_id, '_give_customize_offline_donations', true, 'global' ); |
| 63 | |
| 64 | $global_offline_cc_fields = give_get_option( 'give_offline_donation_enable_billing_fields' ); |
| 65 | |
| 66 | // Output CC Address fields if global option is on and user hasn't elected to customize this form's offline donation options |
| 67 | if ( |
| 68 | ( give_is_setting_enabled( $post_offline_customize_option, 'global' ) && give_is_setting_enabled( $global_offline_cc_fields ) ) |
| 69 | || ( give_is_setting_enabled( $post_offline_customize_option, 'enabled' ) && give_is_setting_enabled( $post_offline_cc_fields ) ) |
| 70 | ) { |
| 71 | give_default_cc_address_fields( $form_id ); |
| 72 | } |
| 73 | } |
| 74 | |
| 75 | add_action( 'give_before_offline_info_fields', 'give_offline_billing_fields', 10, 1 ); |
| 76 | |
| 77 | /** |
| 78 | * Process the payment |
| 79 | * |
| 80 | * @since 1.0 |
| 81 | * |
| 82 | * @param $purchase_data |
| 83 | * |
| 84 | * @return void |
| 85 | */ |
| 86 | function give_offline_process_payment( $purchase_data ) { |
| 87 | |
| 88 | // Setup the payment details. |
| 89 | $payment_data = [ |
| 90 | 'price' => $purchase_data['price'], |
| 91 | 'give_form_title' => $purchase_data['post_data']['give-form-title'], |
| 92 | 'give_form_id' => intval( $purchase_data['post_data']['give-form-id'] ), |
| 93 | 'give_price_id' => isset( $purchase_data['post_data']['give-price-id'] ) ? $purchase_data['post_data']['give-price-id'] : '', |
| 94 | 'date' => $purchase_data['date'], |
| 95 | 'user_email' => $purchase_data['user_email'], |
| 96 | 'purchase_key' => $purchase_data['purchase_key'], |
| 97 | 'currency' => give_get_currency( $purchase_data['post_data']['give-form-id'], $purchase_data ), |
| 98 | 'user_info' => $purchase_data['user_info'], |
| 99 | 'status' => 'pending', |
| 100 | 'gateway' => 'offline', |
| 101 | ]; |
| 102 | |
| 103 | // record the pending payment |
| 104 | $payment = give_insert_payment( $payment_data ); |
| 105 | |
| 106 | if ( $payment ) { |
| 107 | give_send_to_success_page(); |
| 108 | } else { |
| 109 | // if errors are present, send the user back to the donation form so they can be corrected |
| 110 | give_send_back_to_checkout( '?payment-mode=' . $purchase_data['post_data']['give-gateway'] ); |
| 111 | } |
| 112 | |
| 113 | } |
| 114 | |
| 115 | add_action( 'give_gateway_offline', 'give_offline_process_payment' ); |
| 116 | |
| 117 | |
| 118 | /** |
| 119 | * Send Offline Donation Instructions |
| 120 | * |
| 121 | * Sends a notice to the donor with offline instructions; can be customized per form |
| 122 | * |
| 123 | * @param int $payment_id |
| 124 | * |
| 125 | * @since 1.0 |
| 126 | * @return void |
| 127 | */ |
| 128 | function give_offline_send_donor_instructions( $payment_id = 0 ) { |
| 129 | |
| 130 | $payment_data = give_get_payment_meta( $payment_id ); |
| 131 | $post_offline_customization_option = give_get_meta( $payment_data['form_id'], '_give_customize_offline_donations', true ); |
| 132 | |
| 133 | // Customize email content depending on whether the single form has been customized |
| 134 | $email_content = give_get_option( 'global_offline_donation_email' ); |
| 135 | |
| 136 | if ( give_is_setting_enabled( $post_offline_customization_option, 'enabled' ) ) { |
| 137 | $email_content = give_get_meta( $payment_data['form_id'], '_give_offline_donation_email', true ); |
| 138 | } |
| 139 | |
| 140 | $from_name = give_get_option( 'from_name', wp_specialchars_decode( get_bloginfo( 'name' ), ENT_QUOTES ) ); |
| 141 | |
| 142 | /** |
| 143 | * Filters the from name. |
| 144 | * |
| 145 | * @since 1.7 |
| 146 | */ |
| 147 | $from_name = apply_filters( 'give_donation_from_name', $from_name, $payment_id, $payment_data ); |
| 148 | |
| 149 | $from_email = give_get_option( 'from_email', get_bloginfo( 'admin_email' ) ); |
| 150 | |
| 151 | /** |
| 152 | * Filters the from email. |
| 153 | * |
| 154 | * @since 1.7 |
| 155 | */ |
| 156 | $from_email = apply_filters( 'give_donation_from_address', $from_email, $payment_id, $payment_data ); |
| 157 | |
| 158 | $to_email = give_get_payment_user_email( $payment_id ); |
| 159 | |
| 160 | $subject = give_get_option( 'offline_donation_subject', __( 'Offline Donation Instructions', 'give' ) ); |
| 161 | if ( give_is_setting_enabled( $post_offline_customization_option, 'enabled' ) ) { |
| 162 | $subject = give_get_meta( $payment_data['form_id'], '_give_offline_donation_subject', true ); |
| 163 | } |
| 164 | |
| 165 | $subject = apply_filters( 'give_offline_donation_subject', wp_strip_all_tags( $subject ), $payment_id ); |
| 166 | $subject = give_do_email_tags( $subject, $payment_id ); |
| 167 | |
| 168 | $attachments = apply_filters( 'give_offline_donation_attachments', [], $payment_id, $payment_data ); |
| 169 | $message = give_do_email_tags( $email_content, $payment_id ); |
| 170 | |
| 171 | $emails = Give()->emails; |
| 172 | |
| 173 | $emails->__set( 'from_name', $from_name ); |
| 174 | $emails->__set( 'from_email', $from_email ); |
| 175 | $emails->__set( 'heading', __( 'Offline Donation Instructions', 'give' ) ); |
| 176 | |
| 177 | $headers = apply_filters( 'give_receipt_headers', $emails->get_headers(), $payment_id, $payment_data ); |
| 178 | $emails->__set( 'headers', $headers ); |
| 179 | |
| 180 | $emails->send( $to_email, $subject, $message, $attachments ); |
| 181 | |
| 182 | } |
| 183 | |
| 184 | |
| 185 | /** |
| 186 | * Send Offline Donation Admin Notice. |
| 187 | * |
| 188 | * Sends a notice to site admins about the pending donation. |
| 189 | * |
| 190 | * @since 1.0 |
| 191 | * |
| 192 | * @param int $payment_id |
| 193 | * |
| 194 | * @return void |
| 195 | */ |
| 196 | function give_offline_send_admin_notice( $payment_id = 0 ) { |
| 197 | |
| 198 | /* Send an email notification to the admin */ |
| 199 | $admin_email = give_get_admin_notice_emails(); |
| 200 | $user_info = give_get_payment_meta_user_info( $payment_id ); |
| 201 | |
| 202 | if ( isset( $user_info['id'] ) && $user_info['id'] > 0 ) { |
| 203 | $user_data = get_userdata( $user_info['id'] ); |
| 204 | $name = $user_data->display_name; |
| 205 | } elseif ( isset( $user_info['first_name'] ) && isset( $user_info['last_name'] ) ) { |
| 206 | $name = $user_info['first_name'] . ' ' . $user_info['last_name']; |
| 207 | } else { |
| 208 | $name = $user_info['email']; |
| 209 | } |
| 210 | |
| 211 | $amount = give_donation_amount( $payment_id ); |
| 212 | |
| 213 | $admin_subject = apply_filters( 'give_offline_admin_donation_notification_subject', __( 'New Pending Donation', 'give' ), $payment_id ); |
| 214 | |
| 215 | $admin_message = __( 'Dear Admin,', 'give' ) . "\n\n"; |
| 216 | $admin_message .= sprintf( __( 'A new offline donation has been made on your website for %s.', 'give' ), $amount ) . "\n\n"; |
| 217 | $admin_message .= __( 'The donation is in a pending status and is awaiting payment. Donation instructions have been emailed to the donor. Once you receive payment, be sure to mark the donation as complete using the link below.', 'give' ) . "\n\n"; |
| 218 | |
| 219 | $admin_message .= '<strong>' . __( 'Donor:', 'give' ) . '</strong> {fullname}' . "\n"; |
| 220 | $admin_message .= '<strong>' . __( 'Amount:', 'give' ) . '</strong> {amount}' . "\n\n"; |
| 221 | |
| 222 | $admin_message .= sprintf( |
| 223 | '<a href="%1$s">%2$s</a>', |
| 224 | admin_url( 'edit.php?post_type=give_forms&page=give-payment-history&view=view-payment-details&id=' . $payment_id ), |
| 225 | __( 'View Donation Details »', 'give' ) |
| 226 | ) . "\n\n"; |
| 227 | |
| 228 | $admin_message = apply_filters( 'give_offline_admin_donation_notification', $admin_message, $payment_id ); |
| 229 | $admin_message = give_do_email_tags( $admin_message, $payment_id ); |
| 230 | |
| 231 | $attachments = apply_filters( 'give_offline_admin_donation_notification_attachments', [], $payment_id ); |
| 232 | $admin_headers = apply_filters( 'give_offline_admin_donation_notification_headers', [], $payment_id ); |
| 233 | |
| 234 | // Send Email |
| 235 | $emails = Give()->emails; |
| 236 | $emails->__set( 'heading', __( 'New Offline Donation', 'give' ) ); |
| 237 | |
| 238 | if ( ! empty( $admin_headers ) ) { |
| 239 | $emails->__set( 'headers', $admin_headers ); |
| 240 | } |
| 241 | |
| 242 | $emails->send( $admin_email, $admin_subject, $admin_message, $attachments ); |
| 243 | |
| 244 | } |
| 245 | |
| 246 | |
| 247 | /** |
| 248 | * Register gateway settings. |
| 249 | * |
| 250 | * @param $settings |
| 251 | * |
| 252 | * @return array |
| 253 | */ |
| 254 | function give_offline_add_settings( $settings ) { |
| 255 | |
| 256 | // Bailout: Do not show offline gateways setting in to metabox if its disabled globally. |
| 257 | if ( in_array( 'offline', (array) give_get_option( 'gateways' ) ) ) { |
| 258 | return $settings; |
| 259 | } |
| 260 | |
| 261 | // Vars |
| 262 | $prefix = '_give_'; |
| 263 | |
| 264 | $is_gateway_active = give_is_gateway_active( 'offline' ); |
| 265 | |
| 266 | // this gateway isn't active |
| 267 | if ( ! $is_gateway_active ) { |
| 268 | // return settings and bounce |
| 269 | return $settings; |
| 270 | } |
| 271 | |
| 272 | // Fields |
| 273 | $check_settings = [ |
| 274 | |
| 275 | [ |
| 276 | 'name' => __( 'Offline Donations', 'give' ), |
| 277 | 'desc' => __( 'Do you want to customize the donation instructions for this form?', 'give' ), |
| 278 | 'id' => $prefix . 'customize_offline_donations', |
| 279 | 'type' => 'radio_inline', |
| 280 | 'default' => 'global', |
| 281 | 'options' => apply_filters( |
| 282 | 'give_forms_content_options_select', |
| 283 | [ |
| 284 | 'global' => __( 'Global Option', 'give' ), |
| 285 | 'enabled' => __( 'Customize', 'give' ), |
| 286 | 'disabled' => __( 'Disable', 'give' ), |
| 287 | ] |
| 288 | ), |
| 289 | ], |
| 290 | [ |
| 291 | 'name' => __( 'Billing Fields', 'give' ), |
| 292 | 'desc' => __( 'This option will enable the billing details section for this form\'s offline donation payment gateway. The fieldset will appear above the offline donation instructions.', 'give' ), |
| 293 | 'id' => $prefix . 'offline_donation_enable_billing_fields_single', |
| 294 | 'row_classes' => 'give-subfield give-hidden', |
| 295 | 'type' => 'radio_inline', |
| 296 | 'default' => 'disabled', |
| 297 | 'options' => [ |
| 298 | 'enabled' => __( 'Enabled', 'give' ), |
| 299 | 'disabled' => __( 'Disabled', 'give' ), |
| 300 | ], |
| 301 | ], |
| 302 | [ |
| 303 | 'id' => $prefix . 'offline_checkout_notes', |
| 304 | 'name' => __( 'Donation Instructions', 'give' ), |
| 305 | 'desc' => __( 'Enter the instructions you want to display to the donor during the donation process. Most likely this would include important information like mailing address and who to make the check out to.', 'give' ), |
| 306 | 'default' => give_get_default_offline_donation_content(), |
| 307 | 'type' => 'wysiwyg', |
| 308 | 'row_classes' => 'give-subfield give-hidden', |
| 309 | 'options' => [ |
| 310 | 'textarea_rows' => 6, |
| 311 | ], |
| 312 | ], |
| 313 | [ |
| 314 | 'name' => 'offline_docs', |
| 315 | 'type' => 'docs_link', |
| 316 | 'url' => 'http://docs.givewp.com/settings-gateway-offline-donations', |
| 317 | 'title' => __( 'Offline Donations', 'give' ), |
| 318 | ], |
| 319 | ]; |
| 320 | |
| 321 | return array_merge( $settings, $check_settings ); |
| 322 | } |
| 323 | |
| 324 | add_filter( 'give_forms_offline_donations_metabox_fields', 'give_offline_add_settings' ); |
| 325 | |
| 326 | |
| 327 | /** |
| 328 | * Offline Donation Content |
| 329 | * |
| 330 | * Get default offline donation text |
| 331 | * |
| 332 | * @return string |
| 333 | */ |
| 334 | function give_get_default_offline_donation_content() { |
| 335 | $default_text = '<p>' . __( 'To make an offline donation toward this cause, follow these steps:', 'give' ) . ' </p>'; |
| 336 | $default_text .= '<ol>'; |
| 337 | $default_text .= '<li>'; |
| 338 | $default_text .= sprintf( |
| 339 | /* translators: %s: site name */ |
| 340 | __( 'Write a check payable to "{sitename}"', 'give' ) |
| 341 | ); |
| 342 | $default_text .= '</li>'; |
| 343 | $default_text .= '<li>'; |
| 344 | $default_text .= sprintf( |
| 345 | /* translators: %s: site name */ |
| 346 | __( 'On the memo line of the check, indicate that the donation is for "{sitename}"', 'give' ) |
| 347 | ); |
| 348 | $default_text .= '</li>'; |
| 349 | $default_text .= '<li>' . __( 'Mail your check to:', 'give' ) . '</li>'; |
| 350 | $default_text .= '</ol>'; |
| 351 | $default_text .= '{offline_mailing_address}<br>'; |
| 352 | $default_text .= '<p>' . __( 'Your tax-deductible donation is greatly appreciated!', 'give' ) . '</p>'; |
| 353 | |
| 354 | return apply_filters( 'give_default_offline_donation_content', $default_text ); |
| 355 | |
| 356 | } |
| 357 | |
| 358 | /** |
| 359 | * Offline Donation Email Content |
| 360 | * |
| 361 | * Gets the default offline donation email content |
| 362 | * |
| 363 | * @since 2.14.0 Remove unnecessary sprintf |
| 364 | * |
| 365 | * @return string |
| 366 | */ |
| 367 | function give_get_default_offline_donation_email_content() { |
| 368 | $default_text = '<p>' . __( 'Hi {name},', 'give' ) . '</p>'; |
| 369 | $default_text .= '<p>' . __( 'Thank you for letting us know that you\'re mailing a check! Your generosity is greatly appreciated. Here are those steps again:', 'give' ) . '</p>'; |
| 370 | $default_text .= '<ol>'; |
| 371 | $default_text .= '<li>'; |
| 372 | $default_text .= esc_html__( 'Write a check payable to "{sitename}"', 'give' ); |
| 373 | $default_text .= '</li>'; |
| 374 | $default_text .= '<li>'; |
| 375 | $default_text .= esc_html__( 'On the memo line of the check, indicate that the donation is for "{form_title}"', 'give' ); |
| 376 | $default_text .= '</li>'; |
| 377 | $default_text .= '<li>' . __( 'Mail your check to:', 'give' ) . '</li>'; |
| 378 | $default_text .= '</ol>'; |
| 379 | $default_text .= '{offline_mailing_address}<br>'; |
| 380 | $default_text .= '<p>' . esc_html__( 'Once we receive the check, we will mark it as complete in our system, which will generate an email receipt for your records. Please contact us with any questions you may have!', 'give' ) . '</p>'; |
| 381 | $default_text .= '<p>' . esc_html__( 'Thanks in advance!', 'give' ) . '</p>'; |
| 382 | $default_text .= '<p>{sitename}</p>'; |
| 383 | |
| 384 | return apply_filters( 'give_default_offline_donation_content', $default_text ); |
| 385 | } |
| 386 | |
| 387 | /** |
| 388 | * Get formatted offline instructions |
| 389 | * |
| 390 | * @since 2.15.0 |
| 391 | * |
| 392 | * @param string $instructions |
| 393 | * @param int $form_id |
| 394 | * @param bool $wpautop |
| 395 | * |
| 396 | * @return string |
| 397 | */ |
| 398 | function get_formatted_offline_instructions( $instructions, $form_id, $wpautop = false ) { |
| 399 | $settings_url = admin_url( 'post.php?post=' . $form_id . '&action=edit&message=1' ); |
| 400 | |
| 401 | /* translators: %s: form settings url */ |
| 402 | $offline_instructions = ! empty( $instructions ) ? $instructions : sprintf( |
| 403 | __( 'Please enter offline donation instructions in <a href="%s">this form\'s settings</a>.', 'give' ), |
| 404 | $settings_url |
| 405 | ); |
| 406 | |
| 407 | $offline_instructions = give_do_email_tags($offline_instructions, ['form_id' => $form_id]); |
| 408 | |
| 409 | return $wpautop ? wpautop( do_shortcode( $offline_instructions ) ) : $offline_instructions; |
| 410 | } |
| 411 | |
| 412 | /** |
| 413 | * Get offline payment instructions. |
| 414 | * |
| 415 | * @since 2.15.0 - conditionally display instructions based on form settings |
| 416 | * @since 1.7 |
| 417 | * |
| 418 | * @param int $form_id |
| 419 | * @param bool $wpautop |
| 420 | * |
| 421 | * @return string |
| 422 | */ |
| 423 | function give_get_offline_payment_instruction( $form_id, $wpautop = false ) { |
| 424 | // Bailout. |
| 425 | if ( ! $form_id ) { |
| 426 | return ''; |
| 427 | } |
| 428 | |
| 429 | $post_offline_customization_option = give_get_meta( $form_id, '_give_customize_offline_donations', true ); |
| 430 | $post_offline_customization_option_enabled = give_is_setting_enabled( $post_offline_customization_option ); |
| 431 | |
| 432 | if ( $post_offline_customization_option === 'disabled' ) { |
| 433 | return ''; |
| 434 | } |
| 435 | |
| 436 | $post_offline_instructions = give_get_meta( $form_id, '_give_offline_checkout_notes', true ); |
| 437 | $global_offline_instructions = give_get_option( 'global_offline_donation_content' ); |
| 438 | $offline_instructions_content = $post_offline_customization_option_enabled ? $post_offline_instructions : $global_offline_instructions; |
| 439 | |
| 440 | $formatted_offline_instructions = get_formatted_offline_instructions( |
| 441 | $offline_instructions_content, |
| 442 | $form_id, |
| 443 | $wpautop |
| 444 | ); |
| 445 | |
| 446 | /** |
| 447 | * Filter the offline instruction content |
| 448 | * |
| 449 | * @since 2.2.0 |
| 450 | */ |
| 451 | return apply_filters( |
| 452 | 'give_the_offline_instructions_content', |
| 453 | $formatted_offline_instructions, |
| 454 | $offline_instructions_content, |
| 455 | $form_id, |
| 456 | $wpautop |
| 457 | ); |
| 458 | } |
| 459 | |
| 460 | |
| 461 | /** |
| 462 | * Remove offline gateway from gateway list of offline disable for form. |
| 463 | * |
| 464 | * @since 1.8 |
| 465 | * |
| 466 | * @param array $gateway_list |
| 467 | * @param $form_id |
| 468 | * |
| 469 | * @return array |
| 470 | */ |
| 471 | function give_filter_offline_gateway( $gateway_list, $form_id ) { |
| 472 | if ( |
| 473 | // Show offline payment gateway if enable for new donation form. |
| 474 | ( false === strpos( $_SERVER['REQUEST_URI'], '/wp-admin/post-new.php?post_type=give_forms' ) ) |
| 475 | && $form_id |
| 476 | && ! give_is_setting_enabled( give_get_meta( $form_id, '_give_customize_offline_donations', true, 'global' ), [ 'enabled', 'global' ] ) |
| 477 | ) { |
| 478 | unset( $gateway_list['offline'] ); |
| 479 | } |
| 480 | |
| 481 | // Output. |
| 482 | return $gateway_list; |
| 483 | } |
| 484 | |
| 485 | add_filter( 'give_enabled_payment_gateways', 'give_filter_offline_gateway', 10, 2 ); |
| 486 | |
| 487 | /** |
| 488 | * Set default gateway to global default payment gateway |
| 489 | * if current default gateways selected offline and offline payment gateway is disabled. |
| 490 | * |
| 491 | * @since 1.8 |
| 492 | * |
| 493 | * @param string $meta_key Meta key. |
| 494 | * @param string $meta_value Meta value. |
| 495 | * @param int $postid Form ID. |
| 496 | * |
| 497 | * @return void |
| 498 | */ |
| 499 | function _give_customize_offline_donations_on_save_callback( $meta_key, $meta_value, $postid ) { |
| 500 | if ( |
| 501 | ! give_is_setting_enabled( $meta_value, [ 'global', 'enabled' ] ) |
| 502 | && ( 'offline' === give_get_meta( $postid, '_give_default_gateway', true ) ) |
| 503 | ) { |
| 504 | give_update_meta( $postid, '_give_default_gateway', 'global' ); |
| 505 | } |
| 506 | } |
| 507 | |
| 508 | add_filter( 'give_save__give_customize_offline_donations', '_give_customize_offline_donations_on_save_callback', 10, 3 ); |
| 509 |