Switch

The Switch field sets a true or false value based on the selection.  Users may also change the labels of the switch.

Switch Field

Arguments

Name Type Default Description
type string ‘switch’ Value identifying the field type.
id string Unique ID identifying the field. Must be different from all other field IDs.
title string Displays title of the option.
subtitle string Subtitle display of the option, situated beneath the title.
desc string Description of the option, appearing beneath the field control.
class string Appends any number of classes to the field’s class attribute.
compiler bool/array Flag to run the compiler hook or array of CSS selectors to pass dynamic CSS to the compiler hook. More info
required array Provide the parent, comparison operator, and value which affects the field’s visibility. More info
default bool Default value of the switch.
on string ‘On’ Text display for the true value.
off string ‘Off’ Text display for the false value.
permissions string String specifying the capability required to view the section. More info.
hint array Array containing the content and optional title arguments for the hint tooltip. More info

Example Declaration

    $fields = array(
        'id'       => 'opt-switch',
        'type'     => 'switch', 
        'title'    => __('Switch On', 'redux-framework-demo'),
        'subtitle' => __('Look, it\'s on!', 'redux-framework-demo'),
        'default'  => true,
    );

Example Usage

This example in based on the example usage provided above. Be sure to change $redux_demo to the value you specified in your opt_name argument.

global $redux_demo;

echo 'Switch value: ' . $redux_demo['opt-switch'];
Tagged: