Plugin Documentation by “Virginie Garcin, MB Création” v2.0

---

“Reminder for WooCommerce Unpaid Orders”

---

Table of Contents

1. About
2. Installation
3. Setting up the email configuration
4. Sending the email
5. Automation
6. Notes for developpers (hooks)

---

A) About - top

Reminder for WooCommerce Unpaid Orders gives you the ability to send an email to customers who have an "on-hold" order, to remind them to pay for it.

It's the case when a customer placed an order on your WooCommerce store with a payment method like cheque or bank transfer for which you're still expecting the payment. In that case, this plugin will add a button for you, to send him an email (that you may configure) ti incitate him to send you the payment. You also can configure automatic reminders.

---

B) Installation - top

Reminder for WooCommerce Unpaid Orders requires WordPress 3.8+ and WooCommerce 2.0+ (WooCommerce 2.1, 2.2, 2.3 have been successfully tested)

Just like every plugins, just copy the woocommerce-payment-reminder folder in your wp-content/plugins folder then activate it through WordPress dashboard. The plugin is only accessible for Admin's

If the installation went OK, you can now see a new email configuration in the Emails Settings.

Go to WooCommerce > Settings > Emails Tab and then Payment reminder.

Then, configure your settings. Don't forget to check "Enable this email notification" !

---

C) Settings up the email configuration - top

a) Général setup

The général configuration for the sent email is in WooCommerce > Settings > Emails > Payment reminder.

You have several options :

• Enabling or not this email (must be checked if you want the emails to be sent)
• The subject of the email
• The heading (main title) is the email
• The email content of the reminder. You can user thoses variables : order_date}, {order_number}, {order_payment_method} which will be replaced before sending the email. Il you want more variables, you can add some using filters.
• The email type : html, text or both.

b) Custom email template

By default, the used template for the email will be the customer note template ; the email content you set up will appear at the usual place for a note in that template.

The customer note template used will be either the one in the woocommerce plugin directory, either the one you placed in your theme folder, under your-theme/woocommerce/emails/customer-note.php (or your-theme/woocommerce/emails/plain/customer-note.php if you choosed plain email type).

If you want to use a specific template, just add a the new template file 'payment-reminder.php' in your theme directory : your-theme/woocommerce/emails/ (or your-theme/woocommerce/emails/plain/ for plain text emails). To display the message in your template, use the $customer_note variable.

---

D) Sending the email - top

a) With the button

Once the email has been sent, you have the date of the reminder on the tooltip button and in the order note in order detail.

b) With bulk actions

You have an action "send reminder" in the bulk actions list. Select the orders you want to send reminder to, then chose "send reminders" and click on "apply".

Important note: Reminders are sent to each selected order, no matter its status. It assumes that if you selected an order and trigger the "send reminder" action, it's because you know what you're doing, and that you obviously want to send the reminder email to that customer.

E) Automation - top

If automation is enabled, automatic emails will be sent to remind your customers.

Emails will be send to the orders having the statuses you selected.

Please note that automatic emails are independent from manual emails you might send. For example, if you set number of reminders to 3, the plugin will send 3 reminders automatically, no matter if you already sent some reminders manually.

F) Notes for developpers - top

a) Availables filters

Here is the list of available filters :

• wopar_keys_to_find_and_replace_filter : 1/ associative array, the list of keys witch will be searched and replaced in the content of the email. The key is the term searched and the associate value, the replacement. Default :

  array(
  	'{order_date}' => date_i18n( woocommerce_date_format(), strtotime( $this->object->order_date ) ), 
  	'{order_number}' => $this->object->get_order_number(), 
  	'{order_payment_method}' => apply_filters('wopar_payment_method_title_filter',
  		 $this->object->payment_method_title),
  	'{first_name}' => $this->object->billing_first_name,
  	'{last_name}' => $this->object->billing_last_name
  );

  2/ The email object, containg the order on property "object"
• wopar_admin_capabilities_filter : string, the capability required to use the plugin. Default : 'edit_shop_orders'.
• wopar_button_status_filter : array, the statuses for which the action button is shown on the order panel. Default : array( 'on-hold' ).
• wopar_payment_method_title_filter : string, the title of the payment method.
• wopar_template_html_filter : string, the template to use for html email. Default : 'emails/payment-reminder.php'
• wopar_template_plain_filter : string, the template to use for plain text email. Default : 'emails/plain/payment-reminder.php'
• wopar_date_tooltip_text_filter : string, the text of the tooltip on the button when reminder as already been sent. Default : __('Reminder sent on', 'woopar').' '.date(__('Y-m-d', 'woopar'), strtotime($date)).' '.__('at', 'woopar').' '.date(__('H:i:s', 'woopar'), strtotime($date))
• wopar_admin_order_note_text_filter : string, the texte of the note added to the order in backend. Default : __('Sending reminder email', 'woopar').' ('.date(__('Y-m-d', 'woopar'), strtotime($date)).' '.__('at', 'woopar').' '.date(__('H:i:s', 'woopar'), strtotime($date)).')'

b) Usage

wopar_button_status_filter. Exemple : display the action button for both on hold and pending orders

// functions.php of your theme

function my_button_status_filter($array)
{
	return array('on-hold', 'pending');
}
add_filter('wopar_button_status_filter', 'my_button_status_filter');

wopar_keys_to_find_and_replace_filter. Exemple : add a variable {company} in the availables variables for email content

// functions.php of your theme

function my_keys_to_find_and_replace_filter($keys, $email)
{
	$keys['{company}'] = $email->object->billing_company;
	return $keys;
}
add_filter('wopar_keys_to_find_and_replace_filter', 'my_keys_to_find_and_replace_filter', 10, 2);

wopar_payment_method_title_filter. Exemple : change the "Cheque Payment" label by "cheque" in the email.

// functions.php of your theme

function my_payment_method_title_filter($label)
{
	if($label == 'Cheque Payment')
		$label = 'cheque';
	return $label;
}
add_filter('wopar_payment_method_title_filter', 'my_payment_method_title_filter');

Since 2.0 new filters are available. Check into the code, there is probably a filter to achieve what you want to do. If not, please send an email to the support, we will be pleased to add missing filters.

Virginie Garcin – MB Création

Go To Table of Contents

---