Last modified by eMDPlugins Support - 4 months ago
156 Views
4 min read

How to use EMD Custom Field Builder

EMD Custom Field Builder is a very easy to use yet powerful tool to customize our WordPress plugins by creating custom fields.

Custom fields are fields which do not exist by default in the current data model of your plugin. Custom fields help you store and search values specific to your organization's needs. You can create a custom field as an attribute or taxonomy of any predefined entity.

Attribute custom fields are used to document values specific to a entity record. For example, "eye color" and "height" are properties which define a person entity.

On the other hand, taxonomy custom fields are used to create connections between other record types (entities) and/or categorize records of the same type. For example, if a person works at multiple projects, a "project role" taxonomy may be used to document a person's role in a specific project.

As another example, if you are in a restaurant business, you can create a "favorite menu item" attribute to document a customer's frequently ordered dish. You can also document a customer's favorite table location at your restaurant by creating a "favorite seat" taxonomy which stores multiple table locations.

All created custom fields appear on the "Details" tab of the single view and "Custom Fields" box in the admin dashboard editor of the associated entity record.

Using EMD Custom Field builder, you can create:

  • Unlimited number of fields for an entity.
  • Unlimited number of taxonomies for one to many entities.

Any custom field you added before using EMD Custom Field Builder will be automatically created in the custom fields page under your plugin settings.

Please also keep in mind that, once you create a custom field, you can use the same field in your forms, import data specific to that field from external systems (EMD CSV importer/exporter or another connector addon must be installed/purchased) and create shortcodes using that field (you plugin must support EMD Visual Shortcode Builder).

How to create create a custom attribute or taxonomy

  • Click on Custom Fields page under your WordPress plugin settings after logging in as an administrator.
  • Click on "Create New" button to get started.
  • Fill in the required fields first:
    • Singular Label: Insert a singular noun which names one person, place, thing, or idea.
    • Type: Select Attribute or Taxonomy. An attribute is a characteristic or property of person, place, thing, or idea. For example, name, description or, color. A taxonomy is a noun used to classify or group persons, places, things, or ideas. You normally use a taxonomy to relate records of an entity to itself or other entities. For example, contract types, departments, or venue types.
    • Entity: Pick an entity from the dropdown. You can select multiple entities for taxonomy types.
    • Plural label: Insert the plural of the singular label you used for your custom taxonomy. This is only required for taxonomies.
    • Hidden Function Type: Select the type of function to be used. This is only required for hidden function display type.
  • Fill in other optional settings based on your requirement. Each field type has its specific configuration settings. Most display types allow to set a default value for your custom field or taxonomy or make it required.
    You can also set the validation required for data entry such as minimum/maximum characters/words allowed. See Field display types section below for more information about available custom field validation types.
  • Optionally, set "Visibility and Role Accessibility" settings. Visibility defines if the custom field or taxonomy will be enabled, disabled or shown in the admin area only.
    Role Accessibility defines if the field or taxonomy will be accessible by a certain WordPress user role.

Attribute Types

EMD Custom Field Builder provides extensive list of attribute types. You can use these types when creating your custom fields.

The following attribute types are included:

      • Plain Text
      • AlphaNumeric
      • Letters Only
      • Letters with Punctuation
      • No WhiteSpace
      • Password
      • Decimal
      • Digits Only
      • Integer
      • Email
      • Credit Card
      • IP Address V4
      • IP Address V6
      • Mobile UK
      • Phone UK
      • Phone US
      • Postal Code UK
      • Postal Code CA
      • URL
      • VIN Number US
      • Zipcode US
      • Date
      • DateTime
      • Time
      • Textarea
      • Wysiwyg Editor
      • File Uploader
      • Hidden Constant
      • Hidden Function
        • User Email
        • User IP Address
        • User Firstname
        • User Lastname
        • User Display Name
        • User ID
        • Current Date (MM-DD-YYYY)
        • Current Date (DD-MM-YYYY)
        • Current Year (YYYY)
        • Current Month Name (January)
        • Current Month (01)
        • Current Day (01)
        • Now (YYYY-MM-DD HH:mm:ss)
        • Current Time (HH:mm:ss)
        • Unique Identifier
        • Sequence
      • Checkbox
      • Checkbox List
      • Radios
      • Select
      • User List
      • Color Picker
      • Country List
      • State List

Taxonomy Types

EMD Custom Field Builder allows unlimited number of custom taxonomies. You can use your custom taxonomy types to categorize and/or link records of the same or different types.

The following types are supported:

      • hierarchical taxonomies (have descendants) like categories
      • Non-hierarchical taxonomies (have no descendants) like tags.
      • Single select - users can only select at most one value.
      • Multiple select - users can select multiple values.

Import, export or reset custom fields

Migrating from one instance of your plugin (development or stage) to another instance (test or production) is very easy using EMD Custom Field Builder. You can also use this feature to get periodic backups of your custom field meta data.

Use "Export" button at the custom field list page to export all your custom fields to a text file. You can use this option for taking manual backups as well . The created file is in JSON format and named as in "plugin-name_currentdate" format like "empd_pro_cust_fields_09_01_2020.json".

Use "Import" button at the custom field list page to import all your custom fields to a text file. If the custom field name exists, EMD Custom Field Builder automatically updates the field with the new values. If the custom field name does not exists, EMD Custom Field Builder creates a new field.

EMD Custom Field Builder is available in our select WordPress plugins. Please check either the software features or pricing page of your WordPress plugin to see if EMD Custom Field Builder is included or supported.

Was this information helpful?