| Current File : /home/c/i/d/cideo/sainchargny/wp-content/plugins/elementor/includes/controls/media.php |
<?php
namespace Elementor;
if ( ! defined( 'ABSPATH' ) ) {
exit; // Exit if accessed directly.
}
/**
* Elementor media control.
*
* A base control for creating a media chooser control. Based on the WordPress
* media library. Used to select an image from the WordPress media library.
*
* Creating new control in the editor (inside `Widget_Base::_register_controls()`
* method):
*
* $this->add_control(
* 'image',
* [
* 'label' => __( 'Choose Image', 'plugin-domain' ),
* 'type' => Controls_Manager::MEDIA,
* 'default' => [
* 'url' => Utils::get_placeholder_image_src(),
* ]
* ]
* );
*
* PHP usage (inside `Widget_Base::render()` method):
*
* $image = $this->get_settings( 'image' );
* // Get image URL
* echo '<img src="' . $image['url'] . '">';
* // Get image thumbnail by ID
* echo wp_get_attachment_image( $image['id'], 'thumbnail' );
*
* JS usage (inside `Widget_Base::_content_template()` method):
*
* <img src="{{ settings.image.url }}">
*
* @since 1.0.0
*
* @param string $label Optional. The label that appears above of the
* field. Default is empty.
* @param string $title Optional. The field title that appears on mouse
* hover. Default is empty.
* @param string $description Optional. The description that appears below the
* field. Default is empty.
* @param array $default {
* Optional. Defautl media values.
*
* @type int $id Optional. Media id. Default is empty.
* @type string $url Optional. Media url. Use `Utils::get_placeholder_image_src()`
* to retrieve Elementor image placeholder. Default is empty.
* }
* @param string $separator Optional. Set the position of the control separator.
* Available values are 'default', 'before', 'after'
* and 'none'. 'default' will position the separator
* depending on the control type. 'before' / 'after'
* will position the separator before/after the
* control. 'none' will hide the separator. Default
* is 'default'.
* @param bool $show_label Optional. Whether to display the label. Default is
* true.
* @param bool $label_block Optional. Whether to display the label in a
* separate line. Default is true.
*
* @return array {
* An array containing the media ID and URL: `[ 'id' => '', 'url' => '' ]`.
*
* @type int $id Media id.
* @type string $url Media url.
* }
*/
class Control_Media extends Control_Base_Multiple {
/**
* Retrieve media control type.
*
* @since 1.0.0
* @access public
*
* @return string Control type.
*/
public function get_type() {
return 'media';
}
/**
* Retrieve media control default values.
*
* Get the default value of the media control. Used to return the default
* values while initializing the media control.
*
* @since 1.0.0
* @access public
*
* @return array Control default value.
*/
public function get_default_value() {
return [
'url' => '',
'id' => '',
];
}
/**
* Import media images.
*
* Used to import media control files from external sites while importing
* Elementor template JSON file, and replacing the old data.
*
* @since 1.0.0
* @access public
*
* @param array $settings Control settings
*
* @return array Control settings.
*/
public function on_import( $settings ) {
if ( empty( $settings['url'] ) ) {
return $settings;
}
$settings = Plugin::$instance->templates_manager->get_import_images_instance()->import( $settings );
if ( ! $settings ) {
$settings = [
'id' => '',
'url' => Utils::get_placeholder_image_src(),
];
}
return $settings;
}
/**
* Enqueue media control scripts and styles.
*
* Used to register and enqueue custom scripts and styles used by the media
* control.
*
* @since 1.0.0
* @access public
*/
public function enqueue() {
$suffix = defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ? '' : '.min';
wp_enqueue_media();
wp_enqueue_style(
'media',
admin_url( '/css/media' . $suffix . '.css' )
);
wp_register_script(
'image-edit',
'/wp-admin/js/image-edit' . $suffix . '.js',
[
'jquery',
'json2',
'imgareaselect',
],
false,
true
);
wp_enqueue_script( 'image-edit' );
}
/**
* Render media control output in the editor.
*
* Used to generate the control HTML in the editor using Underscore JS
* template. The variables for the class are available using `data` JS
* object.
*
* @since 1.0.0
* @access public
*/
public function content_template() {
?>
<div class="elementor-control-field">
<label class="elementor-control-title">{{{ data.label }}}</label>
<div class="elementor-control-input-wrapper">
<div class="elementor-control-media">
<div class="elementor-control-media-upload-button">
<i class="fa fa-plus-circle" aria-hidden="true"></i>
</div>
<div class="elementor-control-media-image-area">
<div class="elementor-control-media-image" style="background-image: url({{ data.controlValue.url }});"></div>
<div class="elementor-control-media-delete"><?php _e( 'Delete', 'elementor' ); ?></div>
</div>
</div>
</div>
<# if ( data.description ) { #>
<div class="elementor-control-field-description">{{{ data.description }}}</div>
<# } #>
<input type="hidden" data-setting="{{ data.name }}" />
</div>
<?php
}
/**
* Retrieve media control default settings.
*
* Get the default settings of the media control. Used to return the default
* settings while initializing the media control.
*
* @since 1.0.0
* @access protected
*
* @return array Control default settings.
*/
protected function get_default_settings() {
return [
'label_block' => true,
];
}
/**
* Retrieve media control image title.
*
* Get the title of the image selected by the media control.
*
* @since 1.0.0
* @access public
* @static
*
* @param array $attachment Media attachment.
*
* @return string Image title.
*/
public static function get_image_title( $attachment ) {
if ( empty( $attachment['id'] ) ) {
return '';
}
return get_the_title( $attachment['id'] );
}
/**
* Retrieve media control image alt.
*
* Get the alt value of the image selected by the media control.
*
* @since 1.0.0
* @access public
* @static
*
* @param array $attachment Media attachment.
*
* @return string Image alt.
*/
public static function get_image_alt( $instance ) {
if ( empty( $instance['id'] ) ) {
return '';
}
$attachment_id = $instance['id'];
if ( ! $attachment_id ) {
return '';
}
$attachment = get_post( $attachment_id );
if ( ! $attachment ) {
return '';
}
$alt = get_post_meta( $attachment_id, '_wp_attachment_image_alt', true );
if ( ! $alt ) {
$alt = $attachment->post_excerpt;
if ( ! $alt ) {
$alt = $attachment->post_title;
}
}
return trim( strip_tags( $alt ) );
}
}