116 lines
3.0 KiB
PHP
116 lines
3.0 KiB
PHP
<?php
|
|
/**
|
|
* Override field methods
|
|
*
|
|
* @package Kirki
|
|
* @subpackage Controls
|
|
* @copyright Copyright (c) 2020, David Vongries
|
|
* @license https://opensource.org/licenses/MIT
|
|
* @since 2.2.7
|
|
*/
|
|
|
|
/**
|
|
* Field overrides.
|
|
*/
|
|
class Kirki_Field_Image extends Kirki_Field {
|
|
|
|
/**
|
|
* Custom labels.
|
|
* This only exists here for backwards-compatibility purposes.
|
|
*
|
|
* @access public
|
|
* @since 3.0.23
|
|
* @var string
|
|
*/
|
|
public $button_labels = array();
|
|
|
|
/**
|
|
* Sets the control type.
|
|
*
|
|
* @access protected
|
|
*/
|
|
protected function set_type() {
|
|
$this->type = 'kirki-image';
|
|
}
|
|
|
|
/**
|
|
* Sets the button labels.
|
|
*
|
|
* @access protected
|
|
* @since 3.0.23
|
|
* @return void
|
|
*/
|
|
protected function set_button_labels() {
|
|
$this->button_labels = wp_parse_args(
|
|
$this->button_labels,
|
|
array(
|
|
'select' => esc_html__( 'Select image', 'kirki' ),
|
|
'change' => esc_html__( 'Change image', 'kirki' ),
|
|
'default' => esc_html__( 'Default', 'kirki' ),
|
|
'remove' => esc_html__( 'Remove', 'kirki' ),
|
|
'placeholder' => esc_html__( 'No image selected', 'kirki' ),
|
|
'frame_title' => esc_html__( 'Select image', 'kirki' ),
|
|
'frame_button' => esc_html__( 'Choose image', 'kirki' ),
|
|
)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Set the choices.
|
|
* Adds a pseudo-element "controls" that helps with the JS API.
|
|
*
|
|
* @access protected
|
|
*/
|
|
protected function set_choices() {
|
|
if ( ! is_array( $this->choices ) ) {
|
|
$this->choices = (array) $this->choices;
|
|
}
|
|
if ( ! isset( $this->choices['save_as'] ) ) {
|
|
$this->choices['save_as'] = 'url';
|
|
}
|
|
if ( ! isset( $this->choices['labels'] ) ) {
|
|
$this->choices['labels'] = array();
|
|
}
|
|
$this->set_button_labels();
|
|
$this->choices['labels'] = wp_parse_args( $this->choices['labels'], $this->button_labels );
|
|
}
|
|
|
|
/**
|
|
* Sets the $sanitize_callback
|
|
*
|
|
* @access protected
|
|
*/
|
|
protected function set_sanitize_callback() {
|
|
|
|
// If a custom sanitize_callback has been defined,
|
|
// then we don't need to proceed any further.
|
|
if ( ! empty( $this->sanitize_callback ) ) {
|
|
return;
|
|
}
|
|
$this->sanitize_callback = array( $this, 'sanitize' );
|
|
}
|
|
|
|
/**
|
|
* The sanitize method that will be used as a falback
|
|
*
|
|
* @param string|array $value The control's value.
|
|
*/
|
|
public function sanitize( $value ) {
|
|
if ( isset( $this->choices['save_as'] ) && 'array' === $this->choices['save_as'] ) {
|
|
return array(
|
|
'id' => ( isset( $value['id'] ) && '' !== $value['id'] ) ? (int) $value['id'] : '',
|
|
'url' => ( isset( $value['url'] ) && '' !== $value['url'] ) ? esc_url_raw( $value['url'] ) : '',
|
|
'width' => ( isset( $value['width'] ) && '' !== $value['width'] ) ? (int) $value['width'] : '',
|
|
'height' => ( isset( $value['height'] ) && '' !== $value['height'] ) ? (int) $value['height'] : '',
|
|
);
|
|
}
|
|
if ( isset( $this->choices['save_as'] ) && 'id' === $this->choices['save_as'] ) {
|
|
return absint( $value );
|
|
}
|
|
if ( is_string( $value ) ) {
|
|
return esc_url_raw( $value );
|
|
}
|
|
return $value;
|
|
}
|
|
}
|