kirki-framework / control-image
Image control for the Kirki Customizer framework.
This package's canonical repository appears to be gone and the package has been frozen as a result.
Installs: 7 979
Dependents: 1
Suggesters: 0
Security: 0
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 0
Requires
- php: >=7.0
- kirki-framework/control-base: *
- kirki-framework/url-getter: *
This package is auto-updated.
Last update: 2023-01-11 17:48:34 UTC
README
Installation
First, install the package using composer:
composer require kirki-framework/control-image
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\Image' ); } ); /** * 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' => '', 'transport' => 'refresh', // Or postMessage. 'sanitize_callback' => 'sanitize_text_field', // Or a custom sanitization callback. ] ); // Add control. $wp_customize->add_control( new \Kirki\Control\Image( $wp_customize, 'my_control', [ 'label' => esc_html__( 'My Control', 'theme_textdomain' ), 'section' => 'my_section', 'choices' => [ 'save_as' => 'url' // Use "url" or "id" or "array". ], ] ) ); } );