Once your form is built, you may go to Downloads → Tools → Checkout Fields Manager and export your form in .json format. You may also import a previously exported .json file to either restore or recreate a form.

The post Checkout Fields Manager – Importing and Exporting Fields first appeared on Easy Digital Downloads.

FAQ

Can I import custom checkout field data via CSV?
No, custom checkout fields cannot currently be imported via CSV at this time.

The post Checkout Fields Manager – Exporting Payment Data first appeared on Easy Digital Downloads.

Step 1: Set up your custom checkout fields

The first thing you need to do is make sure you have your custom checkout fields set up using Checkout Fields Manager for Easy Digital Downloads.  Follow the setup guide for it here.

Note: Make sure your custom fields are set to save to Payment Meta and not User Meta if you’re passing data related to payments.

You’ll also need to make sure you have installed the EDD Zapier extension.

Additionally, you need to be ready to make a “test” purchase. So put your EDD store into Test Mode by navigating  to Downloads  → Settings → Payment Gateways, and enable Test Mode. You’ll also want to enable the Test Payment Gateway:

Now you are ready to make a test purchase.

Step 2: Set up the “Zap” in your Zapier account.

Now that you have the custom fields created, you can set up the “Zap”, which will collect the new order information and allow you to port it to the 3rd party app of your choice.

In your Zapier account:

1. Click this link to gain access to the (currently private) EDD App: https://zapier.com/developer/invite/26897/ef9fb387de3ff31c7661a7ffaa919d45.
2. Create a new Zap and select Easy Digital Downloads as a triggering service:
3. For the trigger, choose “New Order”:
   
4. Choose the site you are working with. If this is the first time you have created a Zap with Easy Digital Downloads, you will need to authenticate your site by providing your site URL, API Key & API Token. To find those keys, follow the steps in this article
5. Once you have authenticated your site, you’ll be on “Test this Step”. Here you need to complete a test purchase in your store, making sure you fill out the custom fields you’ve set up on your Checkout. By filling them out and completing a test purchase, Zapier will become aware that your custom fields exist.

   First, click the “Connect & Continue” button. This will make Zapier “Listen” for your test purchase.

   Second, complete a test purchase in your EDD Store. In a separate browser tab, go to your store, add one of your products to the cart, and click “Checkout”. Again, make sure you fill out the custom fields on your Checkout page with some test data.
   

6. Once you’ve completed the test purchase, go back to the Zapier tab. It will now say “Test Successful” and look like this:
   
7. Now you can set up the integration with the 3rd party app of your choosing. For this example we will use the “Email” action to email ourself whenever a new order is placed. We’ll make the email body contain my custom field information which was entered by the customer at checkout. For the Body (HTML or Plain) area, click on the top right icon and find your custom field in the dropdown. This will add it to the body.Now that you’ve put your custom field data into the body, you can finish setting up the “Zap” as normal and activate it in your Zapier account. That’s all there is to it!

Note: Keep in mind that it is extremely important that you follow all of these steps in this order. If you don’t you may not see your custom fields in Zapier.

Also, once you’ve set up your “Zap” successfully, make sure to take your store back out of Test Mode in your EDD settings.

The post Zapier integration with Checkout Fields Manager first appeared on Easy Digital Downloads.

For example, this can be used to detect if a purchase is made from a country other than the country associated with the billing address, then flag the purchase as potentially fraudulent.

Enabling Geofencing

The GeoFence feature is located in the ‘Country’ section of the Fraud Monitor configuration under Downloads → Tools → Fraud Monitor → Country.

Obtaining GeoCode API Keys

To obtain accurate location information, Fraud Monitor uses the Google GeoCode API. You need to set up an API Key to use this service.

1) Visit  https://developers.google.com/maps/documentation/geocoding/get-api-key#creating-api-keys

2) Click the ‘Get a Key’ button

3) Set up an API Key

If you have existing API Keys with Google, you need to select ‘+ Create a new project’ and then choose a name for your project:

If you do not have existing API Keys, you’ll be prompted to create one:

In both cases, once you add a project name, click ‘Create and Enable API’

4) Get your API Key for use with Fraud Monitor:

5) Add your GeoCode API Key to the Fraud Monitor settings:

Configuring a GeoFence Type

To allow store owners to customize their settings to suit their needs, Fraud Monitor allows you to configure your fence to be by “Country” or by “Distance”.

By Country

When you choose the ‘country’ setting, Fraud Monitor will compare the country supplied at checkout to the billing information and the country the IP address is registered to. If these two do not match, the payment will be flagged as fraud, for review.

By Distance

The ‘distance’ setting uses the billing address and IP address to approximate a distance based off the GeoLocation data to determine if the purchase was made from within the ‘fence’. It can be configured to use either miles or kilometers.

At the time of writing, the Google GeoCode API no longer limits the number of free requests per day however they do set a limit of maximum 50 requests/second. Once you reach this limit, Fraud Monitor will stop checking the API and bypass the Geofence feature. For more information on increasing that limit, you can see the Usage Limits section of the Google documentation.

The post Fraud Monitor – Configuring Geofencing first appeared on Easy Digital Downloads.

Fraudulent transactions are a common occurrence in this day and age of identity theft. These transactions in your Easy Digital Downloads store can be time consuming to deal with, expensive to pay for, and could even get you blacklisted by payment gateways.

The Fraud Monitor extension uses a variety of tests to filter every transaction, looking for attributes commonly associated with fraudulent purchases. These tests are configured by the site owner.

Note: Before Fraud Monitor will begin monitoring payments, the settings must be configured.

Usage

Transactions are filtered based on the settings configured by the store owner. Filters can be based on:

• IP Address
• Country
• Email address
• Behavior based on formula created by the store owner

Once a transaction has been flagged as fraudulent, it’s placed in a holding area for review by the store owner.

Setup

After you have installed and activated the Fraud Monitor extension, you can find the settings area by navigating to Downloads → Tools→ Fraud Monitor.

1. Review the settings in this document to enable the monitoring features you want to use for your store.
2. (Optional) Configure geofencing.
3. You’ll be notified when a purchase is flagged and needs to be moderated.

The initial tab contains the General settings.

Settings

General

There are three sections on the General tab.

1) General Settings

The option is Moderate Free Purchases. Typically this is off since financial fraud isn’t an option without a payment, but it may be turned on to work in conjunction with other settings to prevent other kinds of abuse.

2) Admin Notifications

This allows an admin notification email to be sent when a transaction is flagged for fraud.

3) Customer Notifications

This will send an email to the customer letting them know the transaction is under review.

Note: if a flagged payment is actually fraudulent, the email address attached to the transaction may not work at all, resulting in a bounceback. This is a common issue.

IP Addresses

Transactions from any IP address placed into the text area shown in the screenshot will immediately be held for review. IP addresses should be entered one per line.

Country

You can choose what service to use to determine a user’s country based on their IP address.

You may configure Fraud Monitor to prevent purchases from specific countries. In the screenshot above, the United Kingdom and Andorra are disallowed. To choose more countries, you may click the input to see a list of countries or start typing to narrow down the list.

Fraud Monitor can be configured to detect differences in the billing information and IP address location to possibly flag a payment for review.

The Country Check setting restricts file downloads from a country other than the one the purchase was made from, if initiated in the first 24 hours from purchase.

Email

Note: This is for email domains, not full email addresses.

Placing a domain like example.com into the text area provided will make it so any transaction using that domain in the buyer’s email address will cause it to be held for moderation.

Additional Email Settings

Optionally you may choose to also check email addresses for patterns typically associated with fraudulent activity. This looks at the entire email address and compares it against known patterns common in fraudulent purchases.

Behavior

This section allows you to make a variety of settings specific to your own products and prices to create a filter customized to your needs.

User History

Typically once a transaction has been approved, that customer bypasses the Fraud Monitor from that point forward. This section gives you the opportunity to require checks for every user on every transaction.

Gateway Settings

If you prefer that purchases made via certain gateways not be moderated at all, you can do that in the Exclude Gateways settings.

Limit Thresholds

This section allows you to set maximum values for:

• Total Purchase Amount
• Total Purchased Items
• Total Purchased Bundles

These three options together can help you create some thresholds for Fraud Monitor.

For example, if you only sell one product, and it doesn’t make sense to buy more than one copy, set the Total Purchased Items to 1.

Another example involves selling 4 things for $1.00 each. You could set the Total Purchase Amount to $4.00, since there’s no reason for people to buy more than one copy.

For Total Purchased Bundles, imagine a scenario where you have two bundles and one bundle includes everything that the other bundle includes, plus more. Buying both bundles would be a waste, since the contents of one are offered in the other. If these were the only bundles on the site, then you’d set the value of Total Purchased Bundles to 2.

Product Combinations

This section allows you to create combinations of products that would indicate a fraudulent purchase. For example, buying an ebook on weight loss while ALSO buying an ebook on weight gain seems unlikely, so you could set that combination to trigger moderation.

The post Fraud Monitor – Installation and usage first appeared on Easy Digital Downloads.

With the EDD Fraud Monitor extension, payments are stored in the Payment Moderation page when they are flagged as fraudulent. The menu item for the Payment Moderation page will have a number next to it indicating how many items are being held for moderation, as seen in the screenshot on the right.

Moderation List

The moderation list, as seen above, tells us these things about each payment:

• Payment ID
• Email address of the customer (with link to View/Edit)
• Total Payment Amount
• Number of reasons it was flagged
• Payment date
• Customer (with link to view the customer record)
• Payment status

Clicking the View/Edit link under the email field (on mouse hover) takes you to the screen for managing the payment.

Processing a Payment in Moderation

The Payment screen for a payment held in moderation is exactly like any other payment, except for the Fraud Monitor box in the top right corner (seen here to the right).

In the Fraud Monitor box, you can see a list of reasons this payment was marked fraudulent and actions you can take.

At the top of the box you have the Remove this flag with no further action link, which basically removes the “fraud” label of that payment so it will no longer show in the Payment Moderation area. Using this action does not change the status of the purchase, which will still be Pending Review.

Accept as Valid

Clicking Accept as Valid simply removes it from the Payment Moderation area and it once again is a normal payment.

This also finishes the transaction by sending a receipt and the proper emails.

Confirm as Fraud

Clicking “Confirm as Fraud” opens a small interface for choosing a way to mark the payment, as seen here on the right. The options are

• Refunded
• Revoked
• Deleted

Refunded

If the payment gateway used for the payment supports refunds, the refund will happen automatically. Otherwise it will have to be done manually after choosing this setting.

Revoked

This does not attempt a refund, but prevents the product from being downloaded.

Deleted

This option simply deletes the payment entirely. Payment fraud is very serious; if you choose this option, make sure the matter was resolved in some way.

The post Fraud Monitor – Payment Moderation first appeared on Easy Digital Downloads.

Setup

After you have installed and activated the MaxMind Fraud Protection extension, you can find the settings area by navigating to Downloads → Settings → Misc.

License Key: This is where you will enter your license key obtained from Easy Digital Downloads.

API Key: This is where you will enter your API key from your MaxMind account.

MaxMind User ID: This field is required if the “Device Tracking” functionality is to be used.

Service: Choose whether to use the minFraud or Proxy Detection service from MaxMind.

Risk Score Limit: Enter the maximum risk score to allow, a valid risk score is between 0.01 and 100. For example, if you enter 20 you would allow up to a 20% chance of fraud.

Proxy Score: Enter the maximum proxy score to allow, a valid proxy score is between 0.00 and 4.00. A score of 0 or 1 will mean a low chance of a proxy being used while 3 or 4 means a medium to high chance of the customer using a proxy.

Error Message: Here you will enter the error message you want to display when the purchase meets or exceeds your risk or proxy score.

Optional Fields: Select optional fields to be used in determining risk scores. While these options are not required, they can help give more reliable results.

Gateway Support: This allows you to choose which installed payment gateways will use the MaxMind services. For credit card gateways that use the default EDD credit card fields, you will need to disable the MaxMind field output using the available options. Only the country field will be displayed by default for gateways that do not use the default credit card fields. You can enable the city, state, and postcode fields for more accurate results.

The post MaxMind Setup Instructions first appeared on Easy Digital Downloads.

Radio Buttons Example

In this example we’re going to use a custom radio buttons field, titled “Are you happy with this purchase process?”. The meta key for this field was automatically generated as are_you_happy_with_this_purchase_process, and we’ve simply made a Yes/No answer option. See below.

Since we’re going to be rendering this information on the customer receipt, let’s take a look at that template. The template we want is called shortcode-receipt.php. Read our docs on how to move this template to your theme.

Near the top of that file you’ll find this code:

$payment = get_post( $edd_receipt_args['id'] );

which creates an object for this payment. In the rest of this file we can now find the ID for this payment under $payment->ID.

In the example above the Meta Key is are_you_happy_with_this_purchase_process. Now that we have both the ID and the Meta Key we can get the value with this code:

get_post_meta( $payment->ID, 'are_you_happy_with_this_purchase_process', true )

Note: the ‘true’ in the example above indicates that we’re expecting a single value from get_post_meta(). Checkout Fields Manager returns a single value for all field types it offers.

Printing to the Receipt

In the above example we got the value we wanted, but now we want to render it nicely in receipts. In shortcode-receipt.php you’ll find a HTML table with a CSS ID of edd_purchase_receipt. You can copy this table and change the values. Here’s an example of a table header:

	 Then we can print a table row for the above question, like this:
Multi-answer Example

	 Some field types allow for multiple answers from a customer. Check boxes allow the customer to select multiple things for example. This is still stored as a single item in meta data; it’s a single array with multiple key/value pairs.  How it gets rendered is slightly different from above, however.

	 Here’s a custom field asking the customer what their favorite animal is:

	 

	 Rendering it in our HTML table would look like this:
ID, 'favorite_animal', true ) as $animal ) {
            $animals .= '
' . $animal . '
' . "n"; 
        }

	// print out the table row, wrapping the results in unordered list tags, and escaping with wp_kses_post()
    ?>
    

	 As you can see it’s only slightly more complicated than the first example.
Wrapping Up

	 Putting together the two code samples from above, we end up with something like this:

    

        

            

        
    
    




    

    
ID ), 'are_you_happy_with_this_purchase_process', true ) ) ); ?>








    

    






ID, 'favorite_animal', true ) as $animal ) {
                $animals .= '
' . $animal . '
' . "n"; 
            }

        // print out the table row, wrapping the results in unordered list tags, and escaping with wp_kses_post()
        ?>
        

    

        

            

        
    
    


    

        

        
ID ), 'are_you_happy_with_this_purchase_process', true ) ) ); ?>
    

    

        

        

    
    

Which will look like this:

Key Points

• To render Custom Fields answers on your receipts, copy the shortcode-receipt.php file to your theme and put your code in there
• Getting the data is simply doing a get_post_meta() call on the Meta Key provided in you the admin area
• All keys from Custom Fields Manager are stored as singles in the post_meta table.

Note: Easy Digital Downloads does not provide support for custom coding/development. If needed we recommend hiring a developer through Codeable make the custom changes you need.

The post Checkout Fields Manager – Getting Meta Data first appeared on Easy Digital Downloads.

Setup

After you have installed and activated the Variable Pricing Switcher extension, you can find the settings area by navigating to Downloads → Settings → Extensions → Variable Pricing Switcher.

Switcher Label: This is the text that will appear on the checkout page above the price switcher.

Disable cart on checkout: Enabling this option will remove the cart from the checkout page. This is particularly useful for single-product sites, or sites that do not need a shopping cart.

Force single variable price: Enabling this option allows for only 1 variable price per product to be be purchased at once.

Usage

When creating or editing a download product there is a new area in the right sidebar titled “Variable Pricing Switcher”. Enable this to allow that download product to have the option to switch variable prices during the checkout process.

Once enabled, when a customer adds an item that has variable pricing options, they will be able to change which pricing option they want during the checkout process.

The post Variable Pricing Switcher first appeared on Easy Digital Downloads.

The meta box will list all of the currently active gateways on your Easy Digital Downloads install. By default, all gateways are allowed for every product. To restrict a download to a specific gateway or gateways, simply check them and hit save! In this example, Paypal and Stripe are the only active gateways.

Configuring Conditional Gateways

Beyond the per-download configuration already discussed, the Conditional Gateway extension requires very little configuration. At present, it only supports a single option which can be found under Downloads→Settings→Payment Gateways→Conditional Gateways.

This option allows you to configure the error message shown in any case where a user may add a combination of products to their cart which results in no gateways being available.

How Conditional Gateways works

By default, Easy Digital Downloads allows you to implement an unlimited number of gateways on your site. For the purposes of this documentation, we are going to assume that you have two active gateways, Paypal Standard and Stripe Standard or Stripe Pro. Now let’s assume that you are an author and are selling ebooks through your website, along with other digital goods. The Paypal Terms of Service explicitly disallows selling ebooks through their gateway so, for your ebooks, you would want to disable the Paypal gateway.

Now, if a user adds an ebook and another digital product to their cart, the system will run through each product in the cart and tally up the allowed gateways for each product. Since the non-ebook product allows both Paypal and Stripe, but the ebook only allows Stripe, the EDD checkout page will only list Stripe. If, however, you have configured all non-ebook products to ONLY allow payment through Paypal, and a user has added the previously mentioned products to the cart, Conditional Gateways will run through the products in the cart and determine that there is no active gateway capable of processing all products in the cart. If this happens, the cart will display a notification (set through options page referenced above) to the user prompting them to remove an item from the cart and disable the checkout button until a valid gateway is found.

The post Setting up Conditional Gateways first appeared on Easy Digital Downloads.

Configuration Instructions

• Once installed, you can locate the settings for this extension by navigating to Downloads → Settings → Extensions → Password Meter.
• Here you will see a variety of options that can be configured to your liking.

Check Mode: This allows you to determine which type of password checking is to be used. “Strict” or “Moderate” are the available options.

Required Strength: This allows you to select the required strength of the password.

Minimum Length: This allows you to set the minimum length of the password that’s being created.

Maximum Length: This allows you to set the maximum length of the password that’s being created.

Disallow Show Password: This allows for the password field to not display the “show password” toggle.

Disallow Password Generation: This removes the “Generate Password” button available on the password field.

Hide Tooltips: This will remove tooltips from the password field.

Front-end Display

Once active, the Password Meter will be automatically in place on the EDD registration form. The Password Meter will alert users if they have not met the criteria set by the site owner in the settings area.

The Password Meter extension also provides a password generator option, which will generate a random password for the user.

The post Password Meter first appeared on Easy Digital Downloads.

Configuration Settings

After you have installed and activated the Upload File extension, you can find the settings area by navigating to Downloads → Extensions → Upload File.

General Settings

File Upload Location: This allows you to choose the location of the upload form, either the Checkout Page or the Receipt Page.

Allowed File Extensions: You can choose which file extensions to allow or leave blank for no restriction on file types.

Maximum Number of Files: This allows you to choose how many files can be uploaded by the user.

Allow User Download: You can choose whether or not the user will be able to download the file on the Purchase Confirmation screen.

Text Settings

Upload Form Title: This is the title of the form upload area.

Upload Form Description: This is the description in the upload area that appears below the title.

Upload Form Line Item: This is the text that appears directly above the upload button. This field accepts the following template tags:

• {limit} – The upload limit for a given product
• {files} – Displays “file” or “files” depending on the upload limit that’s in place
• {product} – The name of the product that uploaded files are relevant to

Usage

Once settings are in place, navigate to a Download product or create a new one. In the right column there will now be a “File Uploads” settings area.

Here you are able to enable file uploads for the Download product, set an upload limit and allowed file extensions, or use the global settings outlined above by leaving blank or at zero.

Once in place, the user will now see an upload form on checkout for any Download product that has “File Uploads” enabled.

Upon a successful transaction, if “Allow User Download” is enabled in the global settings area, the user will see the uploaded file and have the opportunity to download it on the Purchase Confirmation page.

The post Upload File first appeared on Easy Digital Downloads.

Common Field Elements

While there are very few field options that occur on every field, there are some that are on most fields. Here are examples:

Show field on frontend checkout field

This option allows you to show the field either only in the admin or in both the admin and the front of the site. Here’s an example of a field in the builder set to only appear on the back end.

Here’s that same field rendering on the Payment record page ( Downloads → Payment History):

This field may be used by the administrator while the customer need never knows it exists.

Show in exported CSVs

You may choose to include this field in exported CSVs or not

Where should this meta be stored

You may choose to store this meta in the Payment Meta (different values for all orders by a particular user), or User Meta (same value for all orders by a particular user).

Note: If you do not have “Require Login” enabled in your settings, the option to store the data in User Meta will not appear because your users may not have user accounts in which to store the data. This setting can be found by navigating to Downloads → Settings → Misc → Checkout 

Meta Key

This is the name of the meta field in which you wish to store this data. If you leave it blank when creating the field, one will be created for you based on the Field Label.

Note: Do not change the meta key after creating it. If you do, any data created with the former meta key will be lost.

Note: Meta keys may not have spaces. Convention is to replace spaces with an underscore, but a hyphen will also work.

CSS Class Name

This allows you to set a custom CSS class name just for this field.

Size

All fields that are text types have an option for size (width). Results may vary depending on theme used.

Storing data in user meta

As mentioned above, you have the option to store your field either in Payment Meta or User Meta.  Any data stored in User Meta will be attached to the logged in user making the purchase and be available to that user for future use.

An example would be a customer phone number. Once stored in user meta during a transaction, when that customer returns and makes another transaction while logged in their phone number would be already filled in for them.

The customer will also have access to custom fields attached to their user in their Profile Editor, created by the [edd_profile_editor] shortcode.

Note: The option to store data in user meta will only be available if the “Require Login” option is enabled in in Downloads → Settings → Misc → Checkout.

Field Type Options

There are 22 field types to choose from:

Action Hook

This is for developers to add dynamic elements as they want. It provides the chance to add whatever input type you want to add in this form. The image below shows this field with a code example using the Hook Name “hookname”.

Code Example: 

add_action('{hookname}', 'my_function_name}', 10, 4 ); 
// first param: Form Object 
// second param: Save ID of payment if in scope, else -2 
// third param: Save ID of user if in scope, else -2 
// fourth param: Field Object 
function my_function_name( $form, $payment_id, $user_id, $field ) { 	
// Do whatever you want here 
}

Note: Easy Digital Downloads does not provide support for custom coding/development. If needed we recommend hiring a developer through Codeable make the custom changes you need.

Checkbox

Creates a standard generic set of checkboxes.

Country

This field allows you to present a list of countries to the user. The field options include all current countries, and you have the option to add or remove to create a custom list if needed.

Date

This field allows the end user to enter a date, and optionally a time. You may choose whether time may be entered, and whether the start view should be Day, Month, or Year. 

Email

This field appears like a normal text field, but validates input, requiring a valid email address.

File Upload

This field creates a file upload mechanism, and allows you to set a Max. file size, Max. number of files, and allows you to limit file types to these:

• Images (jpg, jpeg, gif, png, bmp)
• Audio (mp3, wav, ogg, wma, mka, m4a, ra, mid, midi)
• Videos (avi, divx, flv, mov, ogv, mkv, mp4, m4v, divx, mpg, mpeg, mpe)
• PDF (pdf)
• Office Documents (doc, ppt, pps, xls, mdb, docx, xlsx, pptx, odt, odp, ods, odg, odc, odb, odf, rtf, txt)
• Zip Archives (zip, gz, gzip, rar, 7z)
• Executable Files (exe)
• CSV (csv)

First Name

This field creates a text field with a default size of 40, and does not include options for meta_key or any of the import/export functions. You also may not create more than one First Name field in a form.

Hidden

This field creates a standard hidden form field. It has ONLY options for meta_key, meta_value, and whether or not to have it be front-end only or both front-end and back-end.

Honeypot

This field creates an empty field that only bots can see, and they will fill it out.  If it’s filled out, form submission is rejected. More information about honeypot fields.

HTML

This field allows you to provide a title and arbitrary HTML.

Last Name

This field is a plain text field that is for Last Name.

Note: Forms come with a Last Name field that cannot be deleted, and you cannot add a second one, which means you probably will never use this option. Occasionally Last Name fields are removed by accident; this option allows you to restore it.

Multiselect

This field creates a standard multi-select select box. You may specify the default select text and create as many options as you wish.

Radio

This field creates a standard set of radio buttons. You may create as many as you wish.

reCAPTCHA

This field creates a reCAPTCHA v3 tool. In order for reCAPTCHA to work, you must insert your site key and secret key in the EDD settings panel. Please navigate to the Downloads > Settings > Extensions > Checkout Fields Manager page and add your API keys there.

If you do not have reCAPTCHA keys, you can obtain them here. Make sure that, when you create your API keys you select reCAPTCHA V3 from the list.

reCAPTCHA v3 works silently, so you will not see this field in your checkout form. reCAPTCHA is automatically disabled for off-site payments such as PayPal.

Repeat

This field creates a text field and presents the customer with the option to create as many more as they wish. Below is an example of the front-end view.

Section Break

This field creates a section break in the form. It allows for a title and description.

Select

This field creates a standard dropdown select field. It functions exactly like the Multi-select above except only one option may be chosen by the customer.

Terms & Cond.

This field allows you to print a block of html containing Terms and Conditions, and also provides a checkbox with a label for the customer to click to agree to.

Text

This field creates a standard html text input field.

Textarea

This field creates a standard html textarea. You may set a number of columns and rows, placeholder text, a default value, and choose between plain textarea, Rich textarea, or Teeny Rich textarea.

URL

This field creates a standard text input field but validates for a URL.

User Email

This field creates a standard text input field but validates for an email address. It is intended to take the email address of a WordPress user.

Note: Similar to Last Name, this field should already exist in your form, and you may not add a second. This option only exists so that you may replace your email field if it’s accidentally removed.

General Usage

Once a field type is clicked on, it will be added to the main column in the center of the screen and you will be presented with several options for the field. The exact options can vary from field type to field type, but all fields share a few common options:

• Required: Select “Yes” if you want customers to be required to fill out the fields, or “No” if it should be optional
• Field Label: This is the text shown as the primary label for the field on checkout
• Help Text: This is the text added below the field on checkout to serve as a helpful explanation of what the customer should enter

After you have added all of the fields you need, simply like the “Save” button located at the top right area of the screen. Once saved, your fields will now be displayed on the checkout.

Important Notes:

There are a few checkout fields that cannot be modified by this extension:

1. Billing Address fields. These are required by credit card payment gateways and by the EDD tax system, so these are not permitted to be modified.

2. The Credit Card form used by payment gateways that process credit cards. Since it is vital these fields appear exactly as expected by EDD, these fields are not allowed to be modified.

The post Checkout Fields Manager – Field Types first appeared on Easy Digital Downloads.

Once the extension is
installed and activated, in your EDD store, go to Downloads → Settings → Payments and find the Gateway Fees section. It’ll look like this:

Applying a fee

At the bottom of the page is an area to set up a label and either a flat fee or a percentage fee for each Gateway you have enabled. The screenshot below shows how you can add a 2.9% + $0.30 cents fee for purchases made with the Test Payment for example.

Once you have a gateway fee set up, it automatically takes effect on the checkout page. Below is the example of a Test Payment fee of 2.9% plus 30 cents per transaction on a $100.00 purchase.

Applying a discount

Add the minus sign to any fee in order to apply a discount. For example, you might want to provide a 3% discount for using
Check Payment Gateway. To do so, input -3 in the “Percent fee for Check Payment” field.

Calculation examples

Note: Gateway Fees calculations can be very confusing.  Please read this section carefully and do experiments on your own calculations.

Something important to keep in mind is that this extension is not intended to simply add a fee to the transaction, but rather take the fees charged by the gateway and pass them on to the customer.

More examples

The post Gateway Fees Setup first appeared on Easy Digital Downloads.

Setup

After you have installed and activated the Gravity Forms Checkout extension, there are no further setup steps – the extension is ready to use.

Note: These instructions require the Gravity Forms Checkout extension as well as Gravity Forms.

Connect to EDD Download

In the Gravity Forms form editor, add a Product field to your form.

Edit the Product field and give it a name you want to show users. In the example below, the product has been named “Product Name.”.

This can be done by hovering over the product field and clicking the “Settings” button.

There will be a dropdown field under the text “Connect to EDD Download.” Select the appropriate EDD product from the list. If the product has variations, you’ll see a message saying there are variations (which require additional setup). Instructions for variable products can be seen below.

Now save the form and you’re done!

Connect to EDD Download with Variable Pricing

When connecting a product with Variable Pricing, you will see an additional message under the “Connect to EDD Download” dropdown stating that the download has variations.

When connecting a Download with Variable Pricing, you’ll also need to add an “Option” field in the form.

Once the “Option” field is in place, select a Download from the “Product Field Mapping” dropdown menu.

If the product you chose has variations, a “Load EDD Options & Prices for this Product” button will appear:

Clicking the “Load EDD Options…” button will load the price variations from the selected Easy Digital Downloads product:

Now save the form and you’re done.

Advanced: How Gravity Forms Checkout Connects with EDD Variations

Either the Name of the product variation or Price ID must be the same as in Easy Digital Downloads.

Connecting using Variation Name

The easiest way to connect the Gravity Forms option choices to Easy Digital Downloads price variations is to give them the same name. The EDD names are automatically loaded when you click the “Load EDD Options & Prices for this Product” button.

Connecting using Variation Price ID

When you enable variable pricing in Easy Digital Downloads, use the name of the price variations.

If instead you want to use a different name, use the number representing the position of the option, starting with one. In the example shown below, the “Good” variation would be 1, “Better” would be 2, and “Best” would be 3.

You can see in the next screenshot that the values that have been set are 1, 2, and 3. even though the names are different, it will be connected because those numbers match the EDD variation positions.

FAQ

Why are Purchases being marked as “Pending”?

There are a few reasons why a Gravity Forms purchase would be marked as Pending in Easy Digital Downloads.

The Gravity Forms form didn’t include any payment methods.

The status will be set to “Pending” if:

• The total of the order is greater than zero
• The connected Gravity Forms form has no configured method of payment; there is no payment made at the time of submission

If this is the case, then you will need to modify the default payment status to be “Completed.”

Gravity Forms hasn’t “heard back” from the payment processor yet

It can take some time for payment processors to notify a website that a payment has been accepted or rejected. During this time, the purchase will be marked as “Pending” until the notification comes in.

Does Gravity Forms Checkout support subscription payments?

No, at this time subscription payments are not supported with Gravity Forms Checkout. If this feature is important to you, please let us know.

How to define the Customer fields that should be used

If you have a form that has multiple name, email, or address fields, you may want to change which fields are used for the Customer.
In Version 2.0, if your form has multiple fields of those types, you will see a new “EDD Fields” form setting.

From the EDD Fields settings page, choose the field that will be used for the EDD Customer. By default, the first field of its type will be used.

How to redirect to the EDD Payment Confirmation page

If you want to show users an Easy Digital Downloads receipt instead of a Gravity Forms receipt, you can do that by updating the Gravity Forms form confirmations. Here’s how.

While in the form, navigate to Settings → Confirmations.

Hover over “Default Confirmation” and click the “Edit” link.

Change the “Confirmation Type” to “Redirect”. Once it’s set to redirect, update the Redirect URL setting to the Purchase Confirmation page URL from Easy Digital Downloads.

Once you have the redirect URL in place, click “Save Confirmation” and new purchases will now be redirected to the Easy Digital Downloads purchase confirmation page. Users will see a receipt generated by Easy Digital Downloads.

Modifications

How to modify the default payment status

The default status of new orders before payment is applied is “Pending.” If you want to accept payments by default, use the code below:

<?php
add_filter( 'edd_gf_default_status', 'modify_edd_gf_default_status', 10, 2 );

/**
 * Modify the default status when there's no status match.
 *
 * @param string $default Default payment status for EDD ("pending" or "publish") (Default: "pending")
 * @param string $status The status of the Gravity Forms entry, set in $entry['payment_status']
 */
function modify_edd_gf_default_status( $default = 'pending', $status = '' ) {
	// Set the default status to be Completed/Paid
	return 'publish';
}

How to include base product download links when purchasing a product with price variations

Prior to Version 1.3, if a customer purchased a product with variable pricing and the base product also had a download associated with it, they would receive a link to the base product as well as the variable product they bought. In Version 1.3, this was changed so that customers would only receive a link to the option they purchased.

If you would like to restore this functionality, add this code to your theme’s functions.php file:

<?php
add_filter('edd_gf_variable_products_include_base', '__return_true');

The post Gravity Forms Checkout Setup and Usage first appeared on Easy Digital Downloads.

Once it is installed and activated, a new menu called Checkout Form will be added to the primary Downloads menu. After navigating to Downloads > Checkout Form, you will be presented with a screen that has a drag-and-drop interface for adding and arranging checkout fields.

To add a field, simply click on the field type you wish to add from the box on the right and it will be added to your form.

Storing Field Data

When creating a new field you’ll usually be asked if you want to store the data in User Meta or Payment Meta. Here’s a brief description of each.

User Meta

User Meta is information about a user. A common WordPress example would be Last Name. If you’re making a new custom field for information related to the user, Secondary Email for example, you should store it in User Meta. This will make that information visible in the Customer Information tab in EDD as well as the Customer Profile Editor for customers to update themselves.

Note: The option to save meta to user will not be available unless Require Login is enabled. To enable go to Downloads → Settings → Misc → Checkout and enable “Require Login”.

Payment Meta

Payment Meta is information about a payment. An example would be quantity. If you’re making a new custom field for information relating to the payment, a field for comments about the product for example, you should store it in Payment Meta. This will make that information visible and editable in the Payment History.

Viewing Custom Fields

For the examples shown below, we’re adding an email text field called Customer Secondary Email. This first image is an example of the setup for all of the User Meta output examples below.

Help Text: This will be shown on the checkout page for this field.

CSS Class Name: You can add custom CSS class for the field in order to style it. (Example: my-custom-class)

Size: You can determine the width of the custom field (results may vary depending on the theme used)

Conditional Logic: Checkout Fields can be shown or hidden based on conditional logic rules either tied to the cart contents or the user. See the Checkout Fields Manager Conditional Logic doc for details on setting up conditional logic rules.

Field Display In Checkout

Once a field is added, and it’s set to show on the checkout form, it will look like this on the checkout form:

Field Display In Profile Editor

If the metadata is stored in User Meta then the field will appear on the customer-facing profile editor which is created by the [edd_profile_editor] shortcode. It will then look like this:

Field Display in Customer Information

If the metadata is stored in User Meta you’ll be able to see it in the Customer Details by navigating to
Downloads > Customers.

Field Display in Payment History

If the metadata is stored in Payment Meta, you’ll be able to see it on the Payment History page for the transaction. This example uses a custom field titled “Payment Info”.

Adding Field Values to Purchase Emails

The checkout field customer responses can be added to the purchase receipt emails and also the admin sale notification emails via template tags.

The template tags that are used for each field are automatically generated based on the “meta_key” field given for each checkout field.

For example, if you have a field called “Company Name” that has a meta_key of “company_name”, you will use {company_name} as the template tag in the emails.

Amazon S3 Integration

If you have the EDD Amazon S3 extension installed, the Checkout Fields Manager ‘File Upload’ field will upload your customer’s files into a folder named ‘cfm’ inside of your Amazon S3 bucket.

Note: Checkout Fields Manager does not integrate with the Free Downloads extension.

The post Checkout Fields Manager – Setup Documentation first appeared on Easy Digital Downloads.

The Auto Register extension for Easy Digital Downloads streamlines the process of making new customers into WordPress users. Typically, to have customers also register as WordPress users you would have to include the account creation fields in the checkout form. Auto Register takes the existing data and automatically creates a user from it, removing an entire step from the checkout process.

Setup

After you have installed and activated the Auto Register extension, you can find the settings area by navigating to Downloads → Settings → Extensions → Auto Register. Your options are:

• Disable the email sent to the user that contains login details
• Disable the new user registration email sent to the admin

Customer Experience

The customer will not see anything on your checkout page that indicates that their information is going to be saved as a user. Auto Register uses the normal EDD checkout fields to gather its information.

Note: With Auto Register turned on, as soon as someone makes a purchase they will be logged into the site as a subscriber. This is especially helpful when using the Recurring Payments extension, which requires the user to be logged in to purchase a subscription product.

Common Questions

What happens if someone already has an account and make a new purchase while logged out?

If a user account already exists for the customer, for security reasons the customer must log in before purchasing a recurring product.

How can I disable the email from sending to the customer?

There’s an option under Downloads → Settings → Extensions → Auto Register.

How can I modify some of the key aspects of the plugin?

There are filters available to modify the behavior of the plugin. See the list below:

• edd_auto_register_email_subject
• edd_auto_register_headers
• edd_auto_register_insert_user_args
• edd_auto_register_email_body
• edd_auto_register_error_must_login
• edd_auto_register_login_form
• edd_auto_register_disable

Can you provide a filter example of how to change the email’s subject?

Add the following to your child theme’s functions.php

    function my_child_theme_edd_auto_register_email_subject( $subject ) {

        // enter your new subject below
	    $subject = 'Here are your new login details';

	    return $subject;

    }
    add_filter( 'edd_auto_register_email_subject', 'my_child_theme_edd_auto_register_email_subject' );

Can you provide a filter example of how to change the email’s body?

Add the following to your child theme’s functions.php

function my_child_theme_edd_auto_register_email_body( $default_email_body, $first_name, $username, $password ) {

	// Modify accordingly
	$default_email_body = __( "Dear", "edd-auto-register" ) . ' ' . $first_name . ",nn";
	$default_email_body .= __( "Below are your login details:", "edd-auto-register" ) . "nn";
	$default_email_body .= __( "Your Username:", "edd-auto-register" ) . ' ' . $username . "nn";
	$default_email_body .= __( "Your Password:", "edd-auto-register" ) . ' ' . $password . "nn";
	$default_email_body .= __( "Login:", "edd-auto-register" ) . ' ' . wp_login_url() . "rn";

	return $default_email_body;

}
add_filter( 'edd_auto_register_email_body', 'my_child_theme_edd_auto_register_email_body', 10, 4 );

NOTE: If you would like to adjust the login URL on the new user email that’s sent, you can use the code snippet found here.

The post Auto Register first appeared on Easy Digital Downloads.