Alignment

PRO

The Alignment controller allows users to select the horizontal and vertical alignment of an element using a visual user interface.

Demonstration

 
Handy::control( 'alignment', [
    'id'          => 'alignment_id',
    'section'     => 'layout_section',
    'label'       => esc_html__( 'Alignment 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 two elements. The first element is horizontal, which only accepts left, center, and right values. And the second element is vertical, which only accepts top, center, and bottom values.

 
Handy::control( 'alignment', [
    'id'          => 'alignment_id',
    'section'     => 'layout_section',
    'default'     => [ 'left', 'top' ],
    'label'       => esc_html__( 'Alignment Control', 'textdomain' ),
    'description' => esc_html__( 'Description Here', 'textdomain' ),
    'priority'    => 1
]);

Basic Usage

 
// Return an array.
$values = get_theme_mod( 'alignment_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 two elements, the first element is `horizontal`, which only accepts `left`, `center`, and `right` values, and the second element is `vertical`, which only accepts `top`, `center`, and `bottom` values. 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.