Theme options
Basic usage of theme options
Adding theme options fields.
php
theme_option()
->setSection([ // Set section with no field
'title' => __('General'),
'desc' => __('General settings'),
'id' => 'opt-text-subsection-general',
'subsection' => true,
'icon' => 'fa fa-home',
])
->setSection([ // Set section with some fields
'title' => __('Logo'),
'desc' => __('Change logo'),
'id' => 'opt-text-subsection-logo',
'subsection' => true,
'icon' => 'fa fa-image',
'fields' => [
[
'id' => 'logo',
'type' => 'mediaImage',
'label' => __('Logo'),
'attributes' => [
'name' => 'logo',
'value' => null,
],
],
],
])
->setField([ // Set field for section
'id' => 'copyright',
'section_id' => 'opt-text-subsection-general',
'type' => 'text',
'label' => __('Copyright'),
'attributes' => [
'name' => 'copyright',
'value' => '© 2016 Botble Technologies. All right reserved.',
'options' => [
'class' => 'form-control',
'placeholder' => __('Change copyright'),
'data-counter' => 120,
]
],
'helper' => __('Copyright on footer of site'),
])
->setArgs(['debug' => true]);Display theme option in the theme.
php
{{ theme_option('option_name') }}or
php
{!! theme_option('option_name') !!}for theme option with HTML content.
Supported fields
- Input (text, password, email, number)
php
->setField([
'id' => 'field_name',
'section_id' => 'opt-text-subsection-section-id',
'type' => 'text', // text, password, email, number
'label' => __('Field label'),
'attributes' => [
'name' => 'field_name',
'value' => null, // default value
'options' => [
'class' => 'form-control',
'placeholder' => __('Placeholder (optional)'),
'data-counter' => 120,
]
],
'helper' => __('Helper text (optional)'),
])- Select
php
->setField([
'id' => 'field_name',
'section_id' => 'opt-text-subsection-section-id',
'type' => 'select', // select or customSelect
'label' => __('Field label'),
'attributes' => [
'name' => 'field_name',
'data' => [ // Array options for select
0 => 'No',
1 => 'Yes',
],
'value' => null, // default value
'options' => [
'class' => 'form-control',
],
],
])- Image
php
->setField([
'id' => 'banner-ads',
'section_id' => 'opt-text-subsection-section-id',
'type' => 'mediaImage',
'label' => __('Image'),
'attributes' => [
'name' => 'banner-ads',
'value' => null,
],
])- Editor (Ckeditor or TinyMCE, you can change it in settings)
php
->setField([
'id' => 'field_name',
'section_id' => 'opt-text-subsection-section-id',
'type' => 'editor',
'label' => __('Field label'),
'attributes' => [
'name' => 'field_name',
'value' => null, // Default value
'options' => [ // Optional
'class' => 'form-control theme-option-textarea',
'row' => '10',
],
],
'helper' => __('Helper for this field (optional)'),
])- On/Off (Radio button)
php
->setField([
'id' => 'field_name',
'section_id' => 'opt-text-subsection-section-id',
'type' => 'onOff',
'label' => __('Field label'),
'attributes' => [
'name' => 'field_name',
'value' => 1,
'data' => [
0 => 'No',
1 => 'Yes',
],
'options' => [],// Optional
],
'helper' => __('Helper for this field (optional)'),
]);- Custom Radio
php
->setField([
'id' => 'field_name',
'section_id' => 'opt-text-subsection-section-id',
'type' => 'customRadio',
'label' => __('Field label'),
'attributes' => [
'name' => 'field_name',
'values' => [
[0, 'No'],
[1, 'Yes'],
],
'selected' => 1,
'options' => [],// Optional
],
'helper' => __('Helper for this field (optional)'),
]);- Custom Select
php
->setField([
'id' => 'field_name',
'section_id' => 'opt-text-subsection-section-id',
'type' => 'customSelect',
'label' => __('Field label'),
'attributes' => [
'values' => [
['field_name[]', 1, 'Option 1'],
['field_name[]', 2, 'Option 2'],
],
'name' => 'whatever', // It will be removed soon
],
'helper' => __('Helper for this field (optional)'),
]);- Repeater fields
php
->setField([
'id' => 'options_name',
'section_id' => 'opt-text-subsection-general',
'type' => 'repeater',
'label' => __('Repeater fields'),
'attributes' => [
'name' => 'options_name',
'value' => null,
'fields' => [
[
'type' => 'text',
'label' => __('Text'),
'attributes' => [
'name' => 'text',
'value' => null,
'options' => [
'class' => 'form-control',
'data-counter' => 255,
],
],
],
[
'type' => 'mediaImage',
'label' => __('Image'),
'attributes' => [
'name' => 'image',
'value' => null,
],
],
[
'type' => 'textarea',
'label' => __('Textarea'),
'attributes' => [
'name' => 'textarea',
'value' => null,
'options' => [
'class' => 'form-control',
'data-counter' => 255,
'rows' => 3,
],
],
],
],
],
])