Checkout Fields Manager - Setup Documentation

 The Checkout Fields Manager extension allows you to add custom fields to the checkout page of your store. Once it is installed, a new menu called Checkout Form will be added to the primary Downloads menu. After clicking on this link, 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.

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 check 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 output examples below.

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 meta data 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 Payment History

If the meta data is stored in Payment Meta you'll be able to see it on the Payment History page for the transaction.

Field Display in Customer Information

If the meta data is stored in User Meta you'll be able to see it in the Customer Details under Downloads Customers.

Adding Field Values to Purchase Emails

The checkout field values 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 purchase emails.

PDF Stamper Integration

Version 2.0.10 of Checkout Fields Manager allow using the custom fields within PDFs distributed with the  PDF Stamper extension. To use a Checkout Fields Manager field within your stamped PDF you can supply the 'Meta Key' value in your PDF Watermark. Using the example above of 'company_name' you would enter the following in your PDF Watermark:


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.