Tabs and fields - 10quality/wpmvc-addon-administrator GitHub Wiki

// Namespace and use statement...

class Settings extends Model
{
    // Class properties...

    protected function init()
    {
        $this->tabs = [
            'tab_id' => [...],
            'tab_id2' => [...],
            // Other tabs...
        ];
        $this->default_tab = 'tab_id';
    }
}

// Namespace and use statement...

class Settings extends Model
{
    // Class properties...

    protected function init()
    {
        $this->tabs = [
            self::NO_TAB => [...],
        ];
    }
}

// Namespace and use statement...

class Settings extends Model
{
    // Class properties...

    protected function init()
    {
        // Other properties...

        $this->tabs = [

            'tab_id' => [

                // The tab title to display in the tab nav menu and tab section title.
                'title' => __( 'Tab #1', 'my-domain' ),

                // Optional tab description. Default: null
                'description' => __( 'Tab description', 'my-domain' ),

                // Font Awesome v4 icon. Default: null
                'icon' => 'fa-star',

                // Flag that indicates if fields should be wrapped in a form
                // with a submit button. Default: true
                'submit' => false,

                // Flag that indicates if tab section title should display. Default: true
                'show_title' => false,

                // List of fields to display. Default: Empty array
                'fields' => [],

            ],

            // Other tabs...
        ];
    }
}

// Namespace and use statement...

class Settings extends Model
{
    // Class properties...

    protected function init()
    {
        // Other properties...

        $this->tabs = [
            'tab_id' => [
                'fields' => [
                    'field_id' => [...],
                    'field_id2' => [...],
                    'custom_id' => [...],
                    // Other fields...
                ],
            ],
        ];
    }
}

// Namespace and use statement...

class Settings extends Model
{
    // Class properties...

    protected function init()
    {
        // Other properties...

        $this->tabs = [
            'tab_id' => [
                'fields' => [

                    'field_id' => [
                        
                        // The type of control that will handle the field.
                        // Default: input(text)
                        'type' => 'input',

                        // Field title to display. Default: field_id
                        'title' => __( 'Field title', 'my-domain' ),

                        // Optional field description to display. Default: Null
                        'description' => __( 'Field description', 'my-domain' ),

                        // Default value when rendering the form. Default: null
                        'default' => null,

                        // Indicates where to store the value for this field.
                        // By default, all field data is stored under the settings model,
                        // which uses only one database record.
                        // If the storage is set to option, this field_id + its value will
                        // be stored individually, allowing it to be used easily in queries.
                        // Default: null
                        'storage' => 'option',

                        // Indicates if option should be autoloaded by WordPress.
                        // Only applies if storage is set to "options". Default: true
                        'autoload' => false,

                        // Additional css classes.
                        // Default: null
                        'class' => ['my-css-class'],

                        // Sanitization callback to use, if set to true, it will use the
                        // the sanitization set by WPMVC\Request, if set to false,
                        // no sanitization is applied. This accepts a callable. Default: true
                        'sanitize_callback' => 'my_custom_sanitize_callable',

                        // Validation callback used to deterimine if the value submitted
                        // is valid. This only accepts a callable and must return a bool.
                        // Default: null
                        'validate_callback' => function( $value, $model ) {
                            return strpos( $value, 'https' ) === 0;
                        },

                        // Custom validation error message. "%s" will be replaced with
                        // the field's title. Default: null
                        'validate_message' => __( '%s must be a secured URL.' ),

                        // Control options. Default: Empty
                        // The options vary depending on the control selected for the field.
                        'control' => [],

                        // Allows to hide/show the field based on conditions.
                        // See the documentation article for this.
                        'show_if' => [...],
                        'hide_if' => [...],

                    ],

                    // Other fields...
                ],
            ],
        ];
    }
}