![\"meetgavern_wp-sidebar\"](\"https:\/\/www.frozenlogistic.com\/wp-content\/uploads\/2012\/07\/meetgavern_wp-sidebar.png\")
<\/a>\u00a0each section is described with a table in the form [code][\u00abBasic\u00bb, \u00aboptions.basic\u00bb, \u00abenabled\u00bb][\/code] the first element of a table is a section name displayed in a panel, the second element is a file name without \u00ab.json<\/strong>\u00bb extension which stores a list of options available in a section given and the third value refers to whether a section given is visible in a panel. In this case, there will be a Basic<\/strong> tab displayed in a panel based on content of\u00a0options.basic.json<\/strong> file.<\/li>\nEach options.*.json file includes three main fields in an object stored:<\/p>\n
- \n
- groupname<\/strong> – it is a section title<\/li>\n
- groupdesc<\/strong> – it specifies a section description displayed directly under a\u00a0 section title<\/li>\n
- fields<\/strong> – it includes a table of objects of fields displayed under the title and a section description<\/li>\n<\/ul>\n
Each field defined by an object including the following fields:<\/p>\n
- \n
- name<\/strong> – it specifies an option name which will be connected with a particular field. There is a prefix added automatically to an option name which is a theme name (it is stored in a global variable – $tpl->name<\/strong>).<\/li>\n
- type<\/strong>– it specifies a field type. Standard fields are:\n
- \n
- TextBlock<\/strong> – a field including a description text – it is not used for storing any option value<\/li>\n
- Text<\/strong> – the easiest text field allowing to insert short text values<\/li>\n
- RawText <\/strong>– pure, simple text without any formatting<\/li>\n
- Textarea<\/strong> – a text field used for inserting a greater number of text values<\/li>\n
- Select<\/strong> – a select field<\/li>\n
- Switcher<\/strong> – a checkbox restricted to two options: \u00abEnabled\u00bb and \u00abDisabled\u00bb<\/li>\n
- Media<\/strong> – a field allowing to choose images<\/li>\n
- WidthHeight<\/strong> – a field allowing to specify two values defining width and height (mostly used with a Media field)<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n
These fields are defined in a gavern\/form_elements\/standard.php<\/strong> file and their code was derived from a GKFormInput<\/strong> field. It is worth remembering that files connected with options are parsed by a gavern\/form.parser.php<\/strong> file. Additionally, you may create your own fields types in a gavern\/form_elements<\/strong> catalog. In GavernWP, we have included the following fields types:
\n<\/strong><\/p>\n- \n
- Menu<\/strong> – a field allowing to generate options connected with page’s menu – used in a Navigation section<\/li>\n
- ThemeStyle<\/strong> – a field allowing to choose page’s style – used at the beginning of a Basic<\/strong> section.<\/li>\n<\/ul>\n
The description of creating your own fields types we will describe in the further part of this article.<\/p>\n
- \n
- label<\/strong> – it specifies a label text visible next to a field<\/li>\n
- tooltip<\/strong> – (optional) it allows to specify tooltip content which will appear after mousing over a label of a field given<\/li>\n
- default<\/strong> – default value of a field given<\/li>\n
- class<\/strong> – (optional) this field allows to specify CSS classes added to an element while generating it (if a field code supported such a functionality)<\/li>\n
- format<\/strong> – (optional) a field specifying a desired field content in the form of a regular expression. e.g. value:\u00a0[code][a-zA-Z]{2,5}[\/code] specifies that a field given will be filled in correctly only when a user set as its value a sequence of capital or small letters from 2 to 5 symbols.<\/li>\n
- required<\/strong> – (optional) allows to specify whether filling in a particular field was required<\/li>\n
- visibility<\/strong> – (optional) specifies when a particular field is visible. Visibility rules are separated with commas and are created in FIELD_NAME=VALUE<\/strong> format – in the case of a few visibility rules, they are linked with AND<\/strong> operator. The value of\u00a0 FIELD_NAME<\/strong> is a name without a prefix with a theme name. e.g. [code]option1=10,option2=20[\/code] will cause that a field given will be visible when an option with\u00a0option1<\/strong> name will be set to 10<\/strong> and, at the same time, an option2<\/strong> option will have have value equals 20<\/strong>.<\/li>\n
- other<\/strong> – (optional) this field is used for storing additional values, e.g. in the case of a Select<\/strong> field, it is used for storing names and options values. This field is very useful when creating more advanced fields which may require additional configuration options.<\/li>\n<\/ul>\n
After adding a new option, you have to remember about its support in the theme. Option value is loaded by using a\u00a0get_option function of a schemata given:<\/p>\n
[code]get_option($tpl->name . ‘_OPTION_NAME’, ‘DEFAULT_VALUE’);[\/code]<\/p>\n
when OPTION_NAME<\/strong> is an option name from a JSON file and DEFAULT_VALUE<\/strong> is default value of an option which will be used when a user does not specify a value of an option given. What is important, there is a \u00ab_<\/strong>\u00bb symbol which you cannot omit. A prefix with a theme name is added in order differentiate values of options of different themes.<\/p>\n
Creating your own field types options<\/h3>\n
While creating a new field type, you have to start from creating a catalog compliant with a field name, e.g. CustomField<\/strong> in a gavern\/form_elements<\/strong> catalog. Then, you have to create a config.json file in this catalog and fill it in according to the schemata below:<\/p>\n
[code]{<\/p>\n
\u00abname\u00bb: \u00abCustomField\u00bb,<\/p>\n
\u00abdescription\u00bb: \u00abExample Custom Field\u00bb,<\/p>\n
\u00abjs\u00bb: false,<\/p>\n
\u00abcss\u00bb: false,<\/p>\n
\u00abphp\u00bb: \u00abcustomfield.php\u00bb,<\/p>\n
\u00abclass\u00bb: \u00abGKFormInputCustomField\u00bb<\/p>\n
}[\/code]<\/p>\n
name<\/strong>, description<\/strong>, php<\/strong> i class<\/strong> fields have to include particular values; js and css fields are optional – they allow to specify whether a field given has to use additional CSS and JavaScript code (then, a name of files from a field catalog has to be set as a value). Also, you have to create a customfield.php<\/strong> file including a GKFormInputCustomField<\/strong> class derived after a GKFormInput<\/strong> class.<\/p>\n
Also, a customfield.css<\/strong> file must include a safety code at the beginning:<\/p>\n
[code]\/\/ disable direct access to the file<\/p>\n
defined(‘GAVERN_WP’) or die(‘Access denied’);[\/code]<\/p>\n
Each field class has to include at least one public method – output<\/strong> not loading any additional arguments. This method must return HTML code of a field given. Field properties froma JSON file are available as class fields, e.g. required<\/strong> is available as:<\/p>\n
[code]$this->required[\/code]<\/p>\n
The second important public methid of each class of a form field is a getValue<\/strong> method which loads one argument – $default<\/strong>. Its use is optional and useful only when a value of a field given uses more than one field in the data base. Then, it is useful to overwrite this method – as an example we recommend a standard code of a WidthHeight<\/strong> field where overwritting a getValue method was used for storing values of two form fields in one main field created by a GKInputFormWidthHeight<\/strong> class.<\/p>\n
The remaining class methods have to be created according to the needs of the author of a form\u00a0 field given.<\/p>\n","protected":false},"excerpt":{"rendered":"
Modification of administration panel content\u00a0 in GavernWP is very easy – it is based on JSON files which include a list of options. Thanks to it, creating new options available …<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[57],"tags":[56,28,71,50],"class_list":["post-427","post","type-post","status-publish","format-standard","hentry","category-theme-back-end","tag-back-end","tag-json","tag-option-files","tag-theme"],"_links":{"self":[{"href":"https:\/\/www.frozenlogistic.com\/index.php?rest_route=\/wp\/v2\/posts\/427","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.frozenlogistic.com\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.frozenlogistic.com\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.frozenlogistic.com\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.frozenlogistic.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=427"}],"version-history":[{"count":3,"href":"https:\/\/www.frozenlogistic.com\/index.php?rest_route=\/wp\/v2\/posts\/427\/revisions"}],"predecessor-version":[{"id":429,"href":"https:\/\/www.frozenlogistic.com\/index.php?rest_route=\/wp\/v2\/posts\/427\/revisions\/429"}],"wp:attachment":[{"href":"https:\/\/www.frozenlogistic.com\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=427"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.frozenlogistic.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=427"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.frozenlogistic.com\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=427"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}
- tooltip<\/strong> – (optional) it allows to specify tooltip content which will appear after mousing over a label of a field given<\/li>\n
- ThemeStyle<\/strong> – a field allowing to choose page’s style – used at the beginning of a Basic<\/strong> section.<\/li>\n<\/ul>\n
- Text<\/strong> – the easiest text field allowing to insert short text values<\/li>\n
- type<\/strong>– it specifies a field type. Standard fields are:\n
- groupdesc<\/strong> – it specifies a section description displayed directly under a\u00a0 section title<\/li>\n