Easy Digital Downloads – Order Notes Readme

Order notes plugin readme file

=== Easy Digital Downloads - Order Notes ===
Contributors: freshlythemes
Tags: easy digital downloads, digital downloads, e-downloads, edd, services, e-commerce, ecommerce, freshlythemes, custom fields, order notes
Requires at least: 3.5
Tested up to: 4.8
Stable tag: trunk
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html

Capture notes and instructions from your customers at the checkout using this lightweight add-on! Perfect for stores or marketplaces selling customizable goods and services.

== Description ==
For anyone wishing to sell customizable goods or services, Easy Digital Downloads provides no out-of-the-box solution to capture notes or special instructions at the checkout without the need to purchase the more expensive (but still awesome!) Checkout Fields Manager add-on. This plugin, however, can be overkill for most website owners who just want a quick–and ideally free–way to collect basic customization information from their prospective customers.

Easy Digital Downloads - Order Notes is a simple free add-on that adds an “Order Notes” text area field to the checkout form, enabling your customers to submit any order-specific instructions and have the data stored and accessible by both parties–store owner and customer.

Features:
 
Lightweight - Bloat-free and lightweight (only 9kb) with no unnecessary options cluttering up your settings screen. Just install and start collecting customer custom order requirements!
 
Seamlessly integrated - Recorded notes are displayed and accessible within the Easy Digital Downloads payment receipt, email notifications (via the {order_notes} tag), exported payment history CSV report, and by frontend submission vendors via their order dashboard.
 
Easy management - All order notes are available to view and edit by administrators and store managers within the View Order Details screen.
 
Frontend submissions integration - Run a services marketplace? This add-on integrates with Frontend Submissions so vendors can view the notes within their Orders Dashboard screen, making it easy for them to fulfill their service obligations.

Make order notes a requirement - Using a simple piece of code (provided below) within your child theme functions.php file, you can make notes a requirement on all customer orders.
 
Export your notes - Order notes are automatically appended to the Payment History CSV export, perfect for archiving and storage purposes. The “notes” are automatically stripped of all unnecessary line breaks and characters within the CSV to keep things legible and condensed.

Easy customization - A range of developer-friendly WordPress actions and filters are provided to allow further customization of the outputted data.
 
Translation ready - Order Notes is translation-ready and contains a POT file to get you started!

== Installation ==
1. Unpack the entire contents of this plugin zip file into your `wp-content/plugins/` folder locally
2. Upload to your site
3. Navigate to `wp-admin/plugins.php` on your site (your WP Admin plugin page)
4. Activate this plugin

OR you can just install it with WordPress by going to Plugins >> Add New >> and type this plugin's name

== Frequently Asked Questions ==
Question: Is the order notes field displayed for all products, or can it be conditionally enabled on either a per-product (or category) basis?
 
Answer: For the initial release, order notes are non-conditional and the checkout field is displayed, but not required on all orders. Per-product and category support is planned for a future release.

Question: How do I make the Order Notes field a requirement on all purchases?
 
Answer: You can add the following action to your child theme functions.php file to make the field a requirement on all orders:
 
add_filter( 'edd_purchase_form_required_fields', 'edd_order_notes_purchase_form_required_fields' );
 
Question: Can I impose a maximum (or minimum) character limit on the order notes?
 
Answer: You can add the following action to your child theme functions.php to impose a 140 character maximum limit on the order notes:
 
function ft_edd_order_notes_validate_checkout_fields( $valid_data, $data ) {
    if ( strlen( $data['edd_order_notes'] ) > 140 ) {
      edd_set_error( 'invalid_order_notes', 'Order notes must be 140 characters or less.' );
    }
}
add_action( 'edd_checkout_error_checks', 'ft_edd_order_notes_validate_checkout_fields', 10, 2 );
 
Note: Replace the 140 with whatever character limit you wish to impose. Similarly, you can switch the > operator to < to impose a minimum character limit (be sure to update the error message wording to reflect this change).


Question: Can I move the location of the outputted notes on the customer payment receipt?
 
Answer: By default the order notes are displayed on a new section within the customer payment receipt to accommodate larger paragraphs while maintaining line breaks. If you do, however, wish to output the notes as part of the payment receipt table, you can use the following code to do so within your child theme functions.php file:
 
remove_action( 'edd_payment_receipt_after_table', 'edd_order_notes_payment_receipt_after_table' );
remove_action( 'fes_payment_receipt_after_table', 'edd_order_notes_payment_receipt_after_table' );

add_action( 'edd_payment_receipt_after', 'edd_order_notes_payment_receipt_after' );
add_action( 'fes_payment_receipt_after', 'edd_order_notes_payment_receipt_after' );
 
Question: Is the plugin available in my native language?
 
Answer: Order Notes includes both the UK and US English international localization files. We have, however, included a POT file to get you started translating into the language of your choice!
 
We always welcome language translation submissions, so if you translate one of our plugins into your native language, please send us the translation file for inclusion in a future release. We credit all submissions.

== Changelog ==
= 1.0 =
* Initial release