Image Uploader

The Image Uploader controller allows users to choose an image from the WordPress Media Library.

Demonstration

 
Handy::control( 'image-uploader', [
    'id'          => 'image_uploader_id',
    'section'     => 'layout_section',
    'label'       => esc_html__( 'Image Uploader Control', 'textdomain' ),
    'description' => esc_html__( 'Description Here', 'textdomain' ),
    'placeholder' => esc_html__( 'Upload Image Here', 'textdomain' ),
    'priority'    => 1
]);

TIP

Here's an example using the default parameter. Note the default value accepts only an attachment ID.

 
Handy::control( 'image-uploader', [
    'id'          => 'image_uploader_id',
    'section'     => 'layout_section',
    'default'     => 100,
    'label'       => esc_html__( 'Image Uploader Control', 'textdomain' ),
    'description' => esc_html__( 'Description Here', 'textdomain' ),
    'placeholder' => esc_html__( 'Upload Image Here', 'textdomain' ),
    'priority'    => 1
]);

TIP

Here's an example using extensions parameter. These are the list of allowed image extensions: jpg, jpeg, png, gif, ico, svg and webp.

 
Handy::control( 'image-uploader', [
    'id'          => 'image_uploader_id',
    'section'     => 'layout_section',
    'default'     => 100,
    'label'       => esc_html__( 'Image Uploader Control', 'textdomain' ),
    'description' => esc_html__( 'Description Here', 'textdomain' ),
    'placeholder' => esc_html__( 'Upload Image Here', 'textdomain' ),
    'extensions'  => [ 'jpg', 'png' ],
    'priority'    => 1
]);

Basic Usage

 
// Return the attachment id.
$value = get_theme_mod( 'image_uploader_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	`integer` `optional` The predetermined value of the control. Accepts only an `attachment ID`. Default empty.
extensions	`array` `optional` The defined image extensions that are allowed. Accepts only `jpg`, `jpeg`, `png`, `gif`, `ico`, `svg` and `webp`. 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.
placeholder	`string` `optional` The placeholder 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.