__( 'A Google Maps widget.', 'so-widgets-bundle' ),
'help' => 'https://siteorigin.com/widgets-bundle/google-maps-widget/'
),
array(),
false,
plugin_dir_path(__FILE__)
);
}
function initialize() {
add_action( 'siteorigin_widgets_before_widget_sow-google-map', array( $this, 'enqueue_widget_scripts' ) );
}
function get_widget_form(){
return array(
'map_center' => array(
'type' => 'textarea',
'rows' => 2,
'label' => __( 'Map center', 'so-widgets-bundle' ),
'description' => sprintf(
__( 'The name of a place, town, city, or even a country. Can be an exact address too. Please ensure you have enabled the Geocoding API in the %sGoogle APIs Dashboard%s.', 'so-widgets-bundle' ),
'',
''
),
),
'api_key_section' => array(
'type' => 'section',
'label' => __( 'API key', 'so-widgets-bundle' ),
'hide' => false,
'fields' => array(
'api_key' => array(
'type' => 'text',
'label' => __( 'API key', 'so-widgets-bundle' ),
'required' => true,
'description' => sprintf(
__( 'Enter your %sAPI key%s. Your map may not function correctly without one.', 'so-widgets-bundle' ),
'',
''
)
)
)
),
'settings' => array(
'type' => 'section',
'label' => __( 'Settings', 'so-widgets-bundle' ),
'hide' => false,
'description' => __( 'Set map display options.', 'so-widgets-bundle' ),
'fields' => array(
'map_type' => array(
'type' => 'radio',
'default' => 'interactive',
'label' => __( 'Map type', 'so-widgets-bundle' ),
'state_emitter' => array(
'callback' => 'select',
'args' => array( 'map_type' )
),
'options' => array(
'interactive' => __( 'Interactive', 'so-widgets-bundle' ),
'static' => __( 'Static image', 'so-widgets-bundle' ),
)
),
'width' => array(
'type' => 'text',
'default' => 640,
'hidden' => true,
'state_handler' => array(
'map_type[static]' => array('show'),
'_else[map_type]' => array('hide'),
),
'label' => __( 'Width', 'so-widgets-bundle' )
),
'height' => array(
'type' => 'text',
'default' => 480,
'label' => __( 'Height', 'so-widgets-bundle' )
),
'destination_url' => array(
'type' => 'link',
'label' => __( 'Destination URL', 'so-widgets-bundle' ),
'hidden' => true,
'state_handler' => array(
'map_type[static]' => array('show'),
'_else[map_type]' => array('hide'),
),
),
'new_window' => array(
'type' => 'checkbox',
'default' => false,
'label' => __( 'Open in a new window', 'so-widgets-bundle' ),
'hidden' => true,
'state_handler' => array(
'map_type[static]' => array('show'),
'_else[map_type]' => array('hide'),
),
),
'zoom' => array(
'type' => 'slider',
'label' => __( 'Zoom level', 'so-widgets-bundle' ),
'description' => __( 'A value from 0 (the world) to 21 (street level).', 'so-widgets-bundle' ),
'min' => 0,
'max' => 21,
'default' => 12,
'integer' => true,
),
'scroll_zoom' => array(
'type' => 'checkbox',
'default' => true,
'state_handler' => array(
'map_type[interactive]' => array('show'),
'_else[map_type]' => array('hide'),
),
'label' => __( 'Scroll to zoom', 'so-widgets-bundle' ),
'description' => __( 'Allow scrolling over the map to zoom in or out.', 'so-widgets-bundle' )
),
'draggable' => array(
'type' => 'checkbox',
'default' => true,
'state_handler' => array(
'map_type[interactive]' => array('show'),
'_else[map_type]' => array('hide'),
),
'label' => __( 'Draggable', 'so-widgets-bundle' ),
'description' => __( 'Allow dragging the map to move it around.', 'so-widgets-bundle' )
),
'disable_default_ui' => array(
'type' => 'checkbox',
'default' => false,
'state_handler' => array(
'map_type[interactive]' => array('show'),
'_else[map_type]' => array('hide'),
),
'label' => __( 'Disable default UI', 'so-widgets-bundle' ),
'description' => __( 'Hides the default Google Maps controls.', 'so-widgets-bundle' )
),
'keep_centered' => array(
'type' => 'checkbox',
'default' => false,
'state_handler' => array(
'map_type[interactive]' => array('show'),
'_else[map_type]' => array('hide'),
),
'label' => __( 'Keep map centered', 'so-widgets-bundle' ),
'description' => __( 'Keeps the map centered when it\'s container is resized.', 'so-widgets-bundle' )
),
'fallback_image' => array(
'type' => 'media',
'label' => __( 'Fallback Image', 'so-widgets-bundle' ),
'description' => __( 'This image will be displayed if there are any problems with displaying the specified map.', 'so-widgets-bundle' ),
'library' => 'image',
),
'fallback_image_size' => array(
'type' => 'image-size',
'label' => __( 'Fallback Image Size', 'so-widgets-bundle' ),
),
)
),
'markers' => array(
'type' => 'section',
'label' => __( 'Markers', 'so-widgets-bundle' ),
'hide' => true,
'description' => __( 'Use markers to identify points of interest on the map.', 'so-widgets-bundle' ),
'fields' => array(
'marker_at_center' => array(
'type' => 'checkbox',
'default' => true,
'label' => __( 'Show marker at map center', 'so-widgets-bundle' )
),
'marker_icon' => array(
'type' => 'media',
'default' => '',
'label' => __( 'Marker icon', 'so-widgets-bundle' ),
'description' => __( 'Replaces the default map marker with your own image.', 'so-widgets-bundle' )
),
'markers_draggable' => array(
'type' => 'checkbox',
'default' => false,
'state_handler' => array(
'map_type[interactive]' => array('show'),
'_else[map_type]' => array('hide'),
),
'label' => __( 'Draggable markers', 'so-widgets-bundle' )
),
'marker_positions' => array(
'type' => 'repeater',
'label' => __( 'Marker positions', 'so-widgets-bundle' ),
'description' => __( 'Please be aware that adding more than 10 markers may cause a slight delay before they appear, due to Google Geocoding API rate limits.', 'so-widgets-bundle' ),
'item_name' => __( 'Marker', 'so-widgets-bundle' ),
'item_label' => array(
'selector' => "[id*='marker_positions-place']",
'update_event' => 'change',
'value_method' => 'val'
),
'fields' => array(
'place' => array(
'type' => 'textarea',
'rows' => 2,
'label' => __( 'Place', 'so-widgets-bundle' )
),
'info' => array(
'type' => 'tinymce',
'rows' => 10,
'label' => __( 'Info Window Content', 'so-widgets-bundle' )
),
'info_max_width' => array(
'type' => 'text',
'label' => __( 'Info Window max width', 'so-widgets-bundle' )
),
'custom_marker_icon' => array(
'type' => 'media',
'default' => '',
'label' => __( 'Custom Marker icon', 'so-widgets-bundle' ),
'description' => __( 'Replace the default map marker with your own image for each marker.', 'so-widgets-bundle' )
),
)
),
'info_display' => array(
'type' => 'radio',
'label' => __( 'When should Info Windows be displayed?', 'so-widgets-bundle' ),
'default' => 'click',
'options' => array(
'click' => __( 'Click', 'so-widgets-bundle' ),
'mouseover' => __( 'Mouse over', 'so-widgets-bundle' ),
'always' => __( 'Always', 'so-widgets-bundle' ),
)
),
'info_multiple' => array(
'type' => 'checkbox',
'label' => __( 'Allow multiple simultaneous Info Windows?', 'so-widgets-bundle' ),
'default' => true,
'description' => __( 'This setting is ignored when Info Windows are set to always display.' )
),
)
),
'styles' => array(
'type' => 'section',
'label' => __( 'Styles', 'so-widgets-bundle' ),
'hide' => true,
'description' => __( 'Apply custom colors to map features, or hide them completely.', 'so-widgets-bundle' ),
'fields' => array(
'style_method' => array(
'type' => 'radio',
'default' => 'normal',
'label' => __( 'Map styles', 'so-widgets-bundle' ),
'state_emitter' => array(
'callback' => 'select',
'args' => array( 'style_method' )
),
'options' => array(
'normal' => __( 'Default', 'so-widgets-bundle' ),
'custom' => __( 'Custom', 'so-widgets-bundle' ),
'raw_json' => __( 'Predefined Styles', 'so-widgets-bundle' ),
)
),
'styled_map_name' => array(
'type' => 'text',
'state_handler' => array(
'style_method[default]' => array('hide'),
'_else[style_method]' => array('show'),
),
'label' => __( 'Styled map name', 'so-widgets-bundle' )
),
'raw_json_map_styles' => array(
'type' => 'textarea',
'state_handler' => array(
'style_method[raw_json]' => array('show'),
'_else[style_method]' => array('hide'),
),
'rows' => 5,
'hidden' => true,
'label' => __( 'Raw JSON styles', 'so-widgets-bundle' ),
'description' => __( 'Copy and paste predefined styles here from Snazzy Maps.', 'so-widgets-bundle' )
),
'custom_map_styles' => array(
'type' => 'repeater',
'state_handler' => array(
'style_method[custom]' => array('show'),
'_else[style_method]' => array('hide'),
),
'label' => __( 'Custom map styles', 'so-widgets-bundle' ),
'item_name' => __( 'Style', 'so-widgets-bundle' ),
'item_label' => array(
'selector' => "[id*='custom_map_styles-map_feature'] :selected",
'update_event' => 'change',
'value_method' => 'text'
),
'fields' => array(
'map_feature' => array(
'type' => 'select',
'label' => '',
'prompt' => __( 'Select map feature to style', 'so-widgets-bundle' ),
'options' => array(
'water' => __( 'Water', 'so-widgets-bundle' ),
'road_highway' => __( 'Highways', 'so-widgets-bundle' ),
'road_arterial' => __( 'Arterial roads', 'so-widgets-bundle' ),
'road_local' => __( 'Local roads', 'so-widgets-bundle' ),
'transit_line' => __( 'Transit lines', 'so-widgets-bundle' ),
'transit_station' => __( 'Transit stations', 'so-widgets-bundle' ),
'landscape_man-made' => __( 'Man-made landscape', 'so-widgets-bundle' ),
'landscape_natural_landcover' => __( 'Natural landscape landcover', 'so-widgets-bundle' ),
'landscape_natural_terrain' => __( 'Natural landscape terrain', 'so-widgets-bundle' ),
'poi_attraction' => __( 'Point of interest - Attractions', 'so-widgets-bundle' ),
'poi_business' => __( 'Point of interest - Business', 'so-widgets-bundle' ),
'poi_government' => __( 'Point of interest - Government', 'so-widgets-bundle' ),
'poi_medical' => __( 'Point of interest - Medical', 'so-widgets-bundle' ),
'poi_park' => __( 'Point of interest - Parks', 'so-widgets-bundle' ),
'poi_place-of-worship' => __( 'Point of interest - Places of worship', 'so-widgets-bundle' ),
'poi_school' => __( 'Point of interest - Schools', 'so-widgets-bundle' ),
'poi_sports-complex' => __( 'Point of interest - Sports complexes', 'so-widgets-bundle' ),
)
),
'element_type' => array(
'type' => 'select',
'label' => __( 'Select element type to style', 'so-widgets-bundle' ),
'options' => array(
'geometry' => __( 'Geometry', 'so-widgets-bundle' ),
'labels' => __( 'Labels', 'so-widgets-bundle' ),
'all' => __( 'All', 'so-widgets-bundle' ),
)
),
'visibility' => array(
'type' => 'checkbox',
'default' => true,
'label' => __( 'Visible', 'so-widgets-bundle' )
),
'color' => array(
'type' => 'color',
'label' => __( 'Color', 'so-widgets-bundle' )
)
)
)
)
),
'directions' => array(
'type' => 'section',
'label' => __( 'Directions', 'so-widgets-bundle' ),
'state_handler' => array(
'map_type[interactive]' => array('show'),
'_else[map_type]' => array('hide'),
),
'hide' => true,
'description' => sprintf(
__( 'Display a route on your map, with waypoints between your starting point and destination. Please ensure you have enabled the Directions API in the %sGoogle APIs Dashboard%s.', 'so-widgets-bundle' ),
'',
''
),
'fields' => array(
'origin' => array(
'type' => 'text',
'label' => __( 'Starting point', 'so-widgets-bundle' )
),
'destination' => array(
'type' => 'text',
'label' => __( 'Destination', 'so-widgets-bundle' )
),
'travel_mode' => array(
'type' => 'select',
'label' => __( 'Travel mode', 'so-widgets-bundle' ),
'default' => 'driving',
'options' => array(
'driving' => __( 'Driving', 'so-widgets-bundle' ),
'walking' => __( 'Walking', 'so-widgets-bundle' ),
'bicycling' => __( 'Bicycling', 'so-widgets-bundle' ),
'transit' => __( 'Transit', 'so-widgets-bundle' )
)
),
'avoid_highways' => array(
'type' => 'checkbox',
'label' => __( 'Avoid highways', 'so-widgets-bundle' ),
),
'avoid_tolls' => array(
'type' => 'checkbox',
'label' => __( 'Avoid tolls', 'so-widgets-bundle' ),
),
'preserve_viewport' => array(
'type' => 'checkbox',
'label' => __( 'Preserve viewport', 'so-widgets-bundle' ),
'description' => __( 'This will prevent the map from centering and zooming around the directions. Use this when you have other markers or features on your map.', 'so-widgets-bundle' ),
),
'waypoints' => array(
'type' => 'repeater',
'label' => __( 'Waypoints', 'so-widgets-bundle' ),
'item_name' => __( 'Waypoint', 'so-widgets-bundle' ),
'item_label' => array(
'selector' => "[id*='waypoints-location']",
'update_event' => 'change',
'value_method' => 'val'
),
'fields' => array(
'location' => array(
'type' => 'textarea',
'rows' => 2,
'label' => __( 'Location', 'so-widgets-bundle' )
),
'stopover' => array(
'type' => 'checkbox',
'default' => true,
'label' => __( 'Stopover', 'so-widgets-bundle' ),
'description' => __( 'Whether or not this is a stop on the route or just a route preference.', 'so-widgets-bundle' )
)
)
),
'optimize_waypoints' => array(
'type' => 'checkbox',
'label' => __( 'Optimize waypoints', 'so-widgets-bundle' ),
'default' => false,
'description' => __( 'Allow the Google Maps service to reorder waypoints for the shortest travelling distance.', 'so-widgets-bundle' )
)
)
),
);
}
function get_settings_form() {
return array(
'api_key' => array(
'type' => 'text',
'label' => __( 'API key', 'so-widgets-bundle' ),
'required' => true,
'description' => sprintf(
__( 'Enter your %sAPI key%s. Your map won\'t function correctly without one.', 'so-widgets-bundle' ),
'',
''
)
)
);
}
function get_template_name( $instance ) {
return $instance['settings']['map_type'] == 'static' ? 'static-map' : 'js-map';
}
function get_style_name( $instance ) {
// We aren't using a LESS style for this widget.
return false;
}
function get_template_variables( $instance, $args ) {
if( empty( $instance ) ) return array();
$settings = $instance['settings'];
$mrkr_src = wp_get_attachment_image_src( $instance['markers']['marker_icon'] );
$styles = $this->get_styles( $instance );
if ( empty( $instance['api_key_section']['api_key'] ) ) {
$global_settings = $this->get_global_settings();
if ( ! empty( $global_settings['api_key'] ) ) {
$instance['api_key_section']['api_key'] = $global_settings['api_key'];
}
}
$fallback_image = '';
if ( ! empty ( $instance['settings']['fallback_image'] ) ) {
$fallback_image = siteorigin_widgets_get_attachment_image(
$instance['settings']['fallback_image'],
$instance['settings']['fallback_image_size'],
false );
}
if ( $settings['map_type'] == 'static' ) {
return array(
'src_url' => $this->get_static_image_src( $instance, $settings['width'], $settings['height'], ! empty( $styles ) ? $styles['styles'] : array() ),
'destination_url' => $instance['settings']['destination_url'],
'new_window' => $instance['settings']['new_window'],
'fallback_image_data' => array( 'img' => $fallback_image ),
);
} else {
$markers = $instance['markers'];
$directions = '';
if ( ! empty( $instance['directions']['origin'] ) && ! empty( $instance['directions']['destination'] ) ) {
if ( empty( $instance['directions']['waypoints'] ) ) {
unset( $instance['directions']['waypoints'] );
}
$directions = siteorigin_widgets_underscores_to_camel_case( $instance['directions'] );
}
$markerpos = isset( $markers['marker_positions'] ) ? $markers['marker_positions'] : '';
if( ! empty($markerpos)) {
foreach ($markerpos as $key => $pos) {
if(! empty($pos['custom_marker_icon'])) {
$icon_src = wp_get_attachment_image_src( $pos['custom_marker_icon'] );
$markerpos[$key]['custom_marker_icon'] = $icon_src[0];
}
}
}
$map_data = siteorigin_widgets_underscores_to_camel_case( array(
'address' => $instance['map_center'],
'zoom' => $settings['zoom'],
'scroll_zoom' => $settings['scroll_zoom'],
'draggable' => $settings['draggable'],
'disable_ui' => $settings['disable_default_ui'],
'keep_centered' => $settings['keep_centered'],
'marker_icon' => ! empty( $mrkr_src ) ? $mrkr_src[0] : '',
'markers_draggable' => isset( $markers['markers_draggable'] ) ? $markers['markers_draggable'] : '',
'marker_at_center' => !empty( $markers['marker_at_center'] ),
'marker_info_display' => $markers['info_display'],
'marker_info_multiple' => $markers['info_multiple'],
'marker_positions' => ! empty( $markerpos ) ? $markerpos : '',
'map_name' => ! empty( $styles ) ? $styles['map_name'] : '',
'map_styles' => ! empty( $styles ) ? $styles['styles'] : '',
'directions' => $directions,
'api_key' => $instance['api_key_section']['api_key'],
));
return array(
'map_id' => md5( $instance['map_center'] ),
'height' => $settings['height'],
'map_data' => $map_data,
'fallback_image_data' => array( 'img' => $fallback_image ),
);
}
}
public function enqueue_widget_scripts( $instance ) {
if ( $instance['settings']['map_type'] == 'interactive' ) {
wp_enqueue_script( 'sow-google-map' );
wp_enqueue_style(
'sow-google-map',
plugin_dir_url(__FILE__) . 'css/style.css',
array(),
SOW_BUNDLE_VERSION
);
wp_localize_script(
'sow-google-map',
'soWidgetsGoogleMap',
array(
'geocode' => array(
'noResults' => __( 'There were no results for the place you entered. Please try another.', 'so-widgets-bundle' ),
),
)
);
} else {
wp_enqueue_script(
'sow-google-map-static',
plugin_dir_url( __FILE__ ) . 'js/static-map' . SOW_BUNDLE_JS_SUFFIX . '.js',
array( 'jquery' ),
SOW_BUNDLE_VERSION
);
}
}
private function get_styles( $instance ) {
$style_config = $instance['styles'];
switch ( $style_config['style_method'] ) {
case 'custom':
if ( empty( $style_config['custom_map_styles'] ) ) {
return array();
} else {
$map_name = ! empty( $style_config['styled_map_name'] ) ? $style_config['styled_map_name'] : 'Custom Map';
$map_styles = $style_config['custom_map_styles'];
$styles = array();
foreach ( $map_styles as $style_item ) {
$map_feature = $style_item['map_feature'];
unset( $style_item['map_feature'] );
$element_type = $style_item['element_type'];
unset( $style_item['element_type'] );
$stylers = array();
foreach ( $style_item as $style_name => $style_value ) {
if ( $style_value !== '' && ! is_null( $style_value ) ) {
$style_value = $style_value === false ? 'off' : $style_value;
array_push( $stylers, array( $style_name => $style_value ) );
}
}
$map_feature = str_replace( '_', '.', $map_feature );
$map_feature = str_replace( '-', '_', $map_feature );
array_push( $styles, array(
'featureType' => $map_feature,
'elementType' => $element_type,
'stylers' => $stylers
) );
}
return array( 'map_name' => $map_name, 'styles' => $styles );
}
case 'raw_json':
if ( empty( $style_config['raw_json_map_styles'] ) ) {
return array();
} else {
$map_name = ! empty( $style_config['styled_map_name'] ) ? $style_config['styled_map_name'] : __( 'Custom Map', 'so-widgets-bundle' );
$styles_string = $style_config['raw_json_map_styles'];
return array( 'map_name' => $map_name, 'styles' => json_decode( $styles_string, true ) );
}
case 'normal':
default:
return array();
}
}
private function get_static_image_src( $instance, $width, $height, $styles ) {
$src_url = "https://maps.googleapis.com/maps/api/staticmap?";
$src_url .= "center=" . $instance['map_center'];
$src_url .= "&zoom=" . $instance['settings']['zoom'];
$src_url .= "&size=" . $width . "x" . $height;
if ( ! empty( $instance['api_key_section']['api_key'] ) ) {
$src_url .= "&key=" . $instance['api_key_section']['api_key'];
}
if ( ! empty( $styles ) ) {
foreach ( $styles as $st ) {
if ( empty( $st ) || ! isset( $st['stylers'] ) || empty( $st['stylers'] ) ) {
continue;
}
$st_string = '';
if ( isset ( $st['featureType'] ) ) {
$st_string .= 'feature:' . $st['featureType'];
}
if ( isset ( $st['elementType'] ) ) {
if ( ! empty( $st_string ) ) {
$st_string .= "|";
}
$st_string .= 'element:' . $st['elementType'];
}
foreach ( $st['stylers'] as $style_prop_arr ) {
foreach ( $style_prop_arr as $prop_name => $prop_val ) {
if ( ! empty( $st_string ) ) {
$st_string .= "|";
}
if ( $prop_val[0] == "#" ) {
$prop_val = "0x" . substr( $prop_val, 1 );
}
if ( is_bool( $prop_val ) ) {
$prop_val = $prop_val ? 'true' : 'false';
}
$st_string .= $prop_name . ":" . $prop_val;
}
}
$st_string = '&style=' . $st_string;
$src_url .= $st_string;
}
}
if ( ! empty( $instance['markers'] ) ) {
$markers = $instance['markers'];
$markers_st = '';
if ( ! empty( $markers['marker_icon'] ) ) {
$mrkr_src = wp_get_attachment_image_src( $markers['marker_icon'] );
if ( ! empty( $mrkr_src ) ) {
$markers_st .= 'icon:' . $mrkr_src[0];
}
}
if ( !empty( $markers['marker_at_center'] ) ) {
if ( ! empty( $markers_st ) ) {
$markers_st .= "|";
}
$markers_st .= $instance['map_center'];
}
if ( ! empty( $markers['marker_positions'] ) ) {
foreach ( $markers['marker_positions'] as $marker ) {
if ( ! empty( $markers_st ) ) {
$markers_st .= "|";
}
$markers_st .= urlencode( $marker['place'] );
}
}
$markers_st = '&markers=' . $markers_st;
$src_url .= $markers_st;
}
return $src_url;
}
}
siteorigin_widget_register( 'sow-google-map', __FILE__, 'SiteOrigin_Widget_GoogleMap_Widget' );