kirki-framework / control-dimensions
This package is abandoned and no longer maintained.
The author suggests using the https://github.com/kirki-framework/field-dimensions package instead.
Dimensions field for the Kirki Customizer framework.
v1.0.0
2021-09-24 08:43 UTC
Requires
- php: >=5.6
- kirki-framework/control-dimension: *
- kirki-framework/url-getter: *
This package is auto-updated.
Last update: 2021-10-14 18:16:10 UTC
README
Installation
First, install the package using composer:
composer require kirki-framework/control-dimensions
Make sure you include the autoloader:
require_once get_parent_theme_file_path( 'vendor/autoload.php' );
To add a control using the customizer API:
/** * Registers the control and whitelists it for JS templating. * * @since 1.0 * @param WP_Customize_Manager $wp_customize The WP_Customize_Manager object. * @return void */ add_action( 'customize_register', function( $wp_customize ) { $wp_customize->register_control_type( '\Kirki\Control\Dimensions' ); } ); /** * Add Customizer settings & controls. * * @since 1.0 * @param WP_Customize_Manager $wp_customize The WP_Customize_Manager object. * @return void */ add_action( 'customize_register', function( $wp_customize ) { // Add setting. $wp_customize->add_setting( 'my_control', [ 'type' => 'theme_mod', 'capability' => 'edit_theme_options', 'default' => [ 'top' => '10px', 'bottom' => '3em', ], 'transport' => 'refresh', // Or postMessage. 'sanitize_callback' => 'sanitize_text_field', // Or a custom sanitization callback. ] ); // Add control. $wp_customize->add_control( new \Kirki\Control\Dimensions( $wp_customize, 'my_control', [ 'label' => esc_html__( 'My Control', 'theme_textdomain' ), 'section' => 'my_section', ] ) ); } );