Custom Fields

From Whirlwind eCommerce Wiki
Revision as of 05:10, 1 October 2008 by Root (Talk | contribs)

Jump to: navigation, search

Custom fields include new field definitions that can be created on the fly as a tool to allow customization of certain site functions to cater to specific client needs. These fields can be created by administrators and are then available for content managers.

Areas of the site the support custom fields

Users
(via the user tab in “settings”).
User custom fields created will be available to apply to all users in the system.
Pages
(via “page template management”).
Page custom field settings will be available to all pages that use the template(s) in which the custom fields are created.

Custom Field Attributes

Each custom field created asks for the following attributes:

Field Name
this is the suffix that will be used when calling on the field (ex: set to “myField” if you want to access it via “custom_field_myField”). This must follow traditional PHP variable name requirements (must begin with a letter, contain only letters, numbers, underscores).
Location
this dictates where in the administration form the field will display relative to permanent fields. Enter the target field name and the word “before” or “after” to dictate where it will appear relative to the target field name. For instance, to place the new custom field after the title field in page management enter “after title”, or to have the field appear before the first name field in user management enter “before firstName”. This entry will have no effect on template managed forms as the fields display and their order will be dictated by the template manager.
Title
this dictates the description of the field in the administration form. When is entered here is exactly what the content manager will see adjacent to the field itself, describing the field. HTML is supported in this field.
Default
sets the default value of the field.
Settings
controls the field type and attributes. The following field types are available: