<?php
namespace Elementor;
use Elementor\Modules\DynamicTags\Module as TagsModule;
if ( ! defined( 'ABSPATH' ) ) {
exit; // Exit if accessed directly.
}
/**
* Elementor google maps widget.
*
* Elementor widget that displays an embedded google map.
*
* @since 1.0.0
*/
class Widget_Google_Maps extends Widget_Base {
/**
* Get widget name.
*
* Retrieve google maps widget name.
*
* @since 1.0.0
* @access public
*
* @return string Widget name.
*/
public function get_name() {
return 'google_maps';
}
/**
* Get widget title.
*
* Retrieve google maps widget title.
*
* @since 1.0.0
* @access public
*
* @return string Widget title.
*/
public function get_title() {
return esc_html__( 'Google Maps', 'elementor' );
}
/**
* Get widget icon.
*
* Retrieve google maps widget icon.
*
* @since 1.0.0
* @access public
*
* @return string Widget icon.
*/
public function get_icon() {
return 'eicon-google-maps';
}
/**
* Get widget categories.
*
* Retrieve the list of categories the google maps widget belongs to.
*
* Used to determine where to display the widget in the editor.
*
* @since 2.0.0
* @access public
*
* @return array Widget categories.
*/
public function get_categories() {
return [ 'basic' ];
}
/**
* Get widget keywords.
*
* Retrieve the list of keywords the widget belongs to.
*
* @since 2.1.0
* @access public
*
* @return array Widget keywords.
*/
public function get_keywords() {
return [ 'google', 'map', 'embed', 'location' ];
}
protected function is_dynamic_content(): bool {
return false;
}
/**
* Get style dependencies.
*
* Retrieve the list of style dependencies the widget requires.
*
* @since 3.24.0
* @access public
*
* @return array Widget style dependencies.
*/
public function get_style_depends(): array {
return [ 'widget-google_maps' ];
}
public function has_widget_inner_wrapper(): bool {
return ! Plugin::$instance->experiments->is_feature_active( 'e_optimized_markup' );
}
/**
* Register google maps widget controls.
*
* Adds different input fields to allow the user to change and customize the widget settings.
*
* @since 3.1.0
* @access protected
*/
protected function register_controls() {
$this->start_controls_section(
'section_map',
[
'label' => esc_html__( 'Google Maps', 'elementor' ),
]
);
if ( Plugin::$instance->editor->is_edit_mode() ) {
$api_key = get_option( 'elementor_google_maps_api_key' );
if ( ! $api_key ) {
$this->add_control(
'api_key_notification',
[
'type' => Controls_Manager::ALERT,
'alert_type' => 'info',
'content' => sprintf(
/* translators: 1: Integration settings link open tag, 2: Create API key link open tag, 3: Link close tag. */
esc_html__( 'Set your Google Maps API Key in Elementor\'s %1$sIntegrations Settings%3$s page. Create your key %2$shere.%3$s', 'elementor' ),
'<a href="' . Settings::get_settings_tab_url( 'integrations' ) . '" target="_blank">',
'<a href="https://developers.google.com/maps/documentation/embed/get-api-key" target="_blank">',
'</a>'
),
]
);
}
}
$default_address = esc_html__( 'London Eye, London, United Kingdom', 'elementor' );
$this->add_control(
'address',
[
'label' => esc_html__( 'Location', 'elementor' ),
'type' => Controls_Manager::TEXT,
'dynamic' => [
'active' => true,
'categories' => [
TagsModule::POST_META_CATEGORY,
],
],
'ai' => [
'active' => false,
],
'placeholder' => $default_address,
'default' => $default_address,
'label_block' => true,
]
);
$this->add_control(
'zoom',
[
'label' => esc_html__( 'Zoom', 'elementor' ),
'type' => Controls_Manager::SLIDER,
'default' => [
'size' => 10,
],
'range' => [
'px' => [
'min' => 1,
'max' => 20,
],
],
'separator' => 'before',
]
);
$this->add_responsive_control(
'height',
[
'label' => esc_html__( 'Height', 'elementor' ),
'type' => Controls_Manager::SLIDER,
'range' => [
'px' => [
'min' => 40,
'max' => 1440,
],
],
'size_units' => [ 'px', 'em', 'rem', 'vh', 'custom' ],
'selectors' => [
'{{WRAPPER}} iframe' => 'height: {{SIZE}}{{UNIT}};',
],
]
);
$this->end_controls_section();
$this->start_controls_section(
'section_map_style',
[
'label' => esc_html__( 'Google Maps', 'elementor' ),
'tab' => Controls_Manager::TAB_STYLE,
]
);
$this->start_controls_tabs( 'map_filter' );
$this->start_controls_tab( 'normal',
[
'label' => esc_html__( 'Normal', 'elementor' ),
]
);
$this->add_group_control(
Group_Control_Css_Filter::get_type(),
[
'name' => 'css_filters',
'selector' => '{{WRAPPER}} iframe',
]
);
$this->end_controls_tab();
$this->start_controls_tab( 'hover',
[
'label' => esc_html__( 'Hover', 'elementor' ),
]
);
$this->add_group_control(
Group_Control_Css_Filter::get_type(),
[
'name' => 'css_filters_hover',
'selector' => '{{WRAPPER}}:hover iframe',
]
);
$this->add_control(
'hover_transition',
[
'label' => esc_html__( 'Transition Duration', 'elementor' ) . ' (s)',
'type' => Controls_Manager::SLIDER,
'range' => [
'px' => [
'min' => 0,
'max' => 3,
'step' => 0.1,
],
],
'selectors' => [
'{{WRAPPER}} iframe' => 'transition-duration: {{SIZE}}s',
],
]
);
$this->end_controls_tab();
$this->end_controls_tabs();
$this->end_controls_section();
}
/**
* Render google maps widget output on the frontend.
*
* Written in PHP and used to generate the final HTML.
*
* @since 1.0.0
* @access protected
*/
protected function render() {
$settings = $this->get_settings_for_display();
if ( empty( $settings['address'] ) ) {
return;
}
if ( 0 === absint( $settings['zoom']['size'] ) ) {
$settings['zoom']['size'] = 10;
}
$api_key = esc_html( get_option( 'elementor_google_maps_api_key' ) );
$params = [
rawurlencode( $settings['address'] ),
absint( $settings['zoom']['size'] ),
];
if ( $api_key ) {
$params[] = $api_key;
$url = 'https://www.google.com/maps/embed/v1/place?key=%3$s&q=%1$s&zoom=%2$d';
} else {
$url = 'https://maps.google.com/maps?q=%1$s&t=m&z=%2$d&output=embed&iwloc=near';
}
?>
<div class="elementor-custom-embed">
<iframe loading="lazy"
src="<?php echo esc_url( vsprintf( $url, $params ) ); ?>"
title="<?php echo esc_attr( $settings['address'] ); ?>"
aria-label="<?php echo esc_attr( $settings['address'] ); ?>"
></iframe>
</div>
<?php
}
/**
* Render google maps widget output in the editor.
*
* Written as a Backbone JavaScript template and used to generate the live preview.
*
* @since 2.9.0
* @access protected
*/
protected function content_template() {}
public function render_markdown(): string {
$settings = $this->get_settings_for_display();
$address = Utils::html_to_plain_text( $settings['address'] ?? '' );
if ( empty( $address ) ) {
return '';
}
return '[Map: ' . $address . '](https://maps.google.com/maps?q=' . rawurlencode( $address ) . ')';
}
}