Dimension

PRO

The Dimension controller allows users to modify size, padding and margin of an element.

Demonstration

 
Handy::control( 'dimension', [
    'id'          => 'dimension_id',
    'section'     => 'layout_section',
    'label'       => esc_html__( 'Dimension Control', 'textdomain' ),
    'description' => esc_html__( 'Description Here', 'textdomain' ),
    'priority'    => 1
]);

TIP

Here's an example using the default parameter. Note the default value accepts only an array data type that contains three elements. The first element is size, which contains the width and height values. The second element is padding, which contains the top, right, bottom and left values. And the last element is margin, which contains the top, right, bottom and left values. And also keep in mind that if an element is missing, it will hide the input field related on it.

 
Handy::control( 'dimension', [
    'id'          => 'dimension_id',
    'section'     => 'layout_section',
    'default'     => [
        'size'    => [ '100px', '100px' ],
        'padding' => [ '0px', '0em', '0px', '0em' ],
        'margin'  => [ '0px', '0em', '0px', '0em' ]
    ],
    'label'       => esc_html__( 'Dimension Control', 'textdomain' ),
    'description' => esc_html__( 'Description Here', 'textdomain' ),
    'priority'    => 1
]);

Basic Usage

 
// Returns an array.
$values = get_theme_mod( 'dimension_id' );

Parameters

Name	Description
id	`string` `required` The unique slug like string used as an ID and also as an index name in storing data in a database.
section	`string` `required` The ID of the section in which the control will be displayed.
default	`array` `optional` The predetermined value of the control. Accepts an `array` with three elements. The first element is `size`, which contains the `width` and `height` values. The second element is `padding`, which contains the `top`, `right`, `bottom` and `left` values. And the last element is `margin`, which contains the `top`, `right`, `bottom` and `left` values. And also keep in mind that if an element is missing, it will hide the input field related on it. Default empty `array`.
label	`string` `optional` The label or title of the control to show in the UI. Default empty.
description	`string` `optional` The description of the control to show in the UI. Default empty.
priority	`integer` `optional` The order of control appears in the section. Default `0`.
validations	`array` `optional` The set of validations used to validate the value of the control. For further details, read validations. Default empty.
active_callback	`callable` `optional` A callback function that determines the visibility of a control, whether to show or hide depending on a condition. For further details, read active_callback. Default empty.
sanitize_callback	`callable` `optional` A callback function that sanitizes the value of control before storing it in the database. Note that this is only optional since each control is already well sanitized. For further details, read sanitize_callback. Default empty.