redSHOP Custom Fields

Using custom fields allows you to add additional data and / or interaction to any view in your redSHOP, and combining this with the redSHOP template system gives you a flexible and powerful system to customize your shop to fit most any need.

The following outlines the Workflow for adding a custom field to a redSHOP view.

Visit redSHOP's Customisation view
Add your custom field to redSHOP by going to Customisation -> Custom Fields -> Add Custom Field
Define the details of this custom field.
  1. Type: Select the type of custom field this will be.  You can choose from;
    • Select
    • Checkbox
    • Country selection box
    • Date picker
    • Documents
    • Image
    • Image with link
    • Media
    • Multiple select box
    • Radio buttons
    • Selections Based on Selected Conditions
    • Single Select
    • Text Tag Content
    • Text Area
  2. Section: The Section is where you would like to use this custom field.  You can choose from;
    • Category
    • Company Billing Address
    • Company Shipping Address
    • Gift Card user field
    • Manufacturer
    • Payment Gateway
    • Private Billing Address
    • Private Shipping Address
    • * Product
    • * Product user field
    • * Product Date Picker
    • Quotation
    • Sample
    • Shipping
    • Shipping Gateway
  3. Name: This is the name that will be used to add your custom field to Templates.  The name should be in lowercase, and an underscore ( _ ) used for spaces. 
    On save the name will be changed to a format to work with redSHOP if not created as such, ie:  rs_custom_field_name
  4. Field Title: Give the field a title.  This is what will be shown when the custom field is presented in the backend.
  5. CSS Class: You can apply a class to this field to allow styling it with CSS
  6. Maximum Length: Default is 30.  This is the maximum number of characters you wish to allow in this field.
  7. Size: Default is 20.  This is the width of the field in pixels.
  8. Columns: Default is 10.  Relevant only for Text Area or Multi-select field types.
  9. Rows: Default is 10.  Relevant only for Text Area or Multi-select field types.
  10. Show in Front: No/Yes.  No is default.  This option allows you to show data from this custom field in the frontend of the shop. *It is necessary to first add the field name to the template for the view you'd like to display this data in.  More on that to later in this tutorial.
  11. Required: No/yes.  No is default.
  12. Published: No/Yes.  Yes is default.
  13. Description:  Add a description for this custom field if you'd like.

*If you select the Product, Product user field, or Product Date Picker you will see two additional options to set: Display in Product List: No/yes.  Yes is default.  Yes will show the custom field data when viewing the product list in the backend.

Show in Checkout: No/Yes.  No is default.  Yes will show the custom field data in the checkout page.

Add the custom field to the desired view Template
  1. Find the desired template by going to Template -> Template List and selecting the Template you wish to add your custom field to.
  2. Add the {rs_custom_field_name} to the template, where you would like it to be displayed in the output / view.  The following example is for adding a custom field to a Product template.  This will display our custom field output just under the Product Description:

Once you've added the field to a template the field will be available in the backend view for the Section you've added it.

For example, if you've added the {rs_custom_field_name} to the Product template, then in the Product View you will see the custom field under the Custom Fields tab as seen below: