'widget_contact_info',
'description' => __( 'Display a map with your location, hours, and contact information.', 'jetpack' ),
'customize_selective_refresh' => true,
'show_instance_in_rest' => true,
);
parent::__construct(
'widget_contact_info',
/** This filter is documented in modules/widgets/facebook-likebox.php */
apply_filters( 'jetpack_widget_name', __( 'Contact Info & Map', 'jetpack' ) ),
$widget_ops
);
$this->alt_option_name = 'widget_contact_info';
if ( is_customize_preview() ) {
add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_scripts' ) );
} elseif ( 'widgets.php' === $pagenow ) {
add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_scripts' ) );
}
add_action( 'wp_ajax_customize-contact-info-api-key', array( $this, 'ajax_check_api_key' ) );
add_filter( 'widget_types_to_hide_from_legacy_widget_block', array( $this, 'hide_widget_in_block_editor' ) );
}
/**
* Remove the "Contact info and Map" widget from the Legacy Widget block
*
* @param array $widget_types List of widgets that are currently removed from the Legacy Widget block.
* @return array $widget_types New list of widgets that will be removed.
*/
public function hide_widget_in_block_editor( $widget_types ) {
$widget_types[] = 'widget_contact_info';
return $widget_types;
}
/**
* Enqueue scripts and styles.
*/
public function enqueue_scripts() {
wp_enqueue_style(
'contact-info-map-css',
plugins_url( 'contact-info/contact-info-map.css', __FILE__ ),
array(),
JETPACK__VERSION
);
}
/**
* Return an associative array of default values
*
* These values are used in new widgets.
*
* @return array Array of default values for the Widget's options
*/
public function defaults() {
return array(
'title' => __( 'Hours & Info', 'jetpack' ),
'address' => __( "3999 Mission Boulevard,\nSan Diego CA 92109", 'jetpack' ),
'phone' => _x( '1-202-555-1212', 'Example of a phone number', 'jetpack' ),
'hours' => __( "Lunch: 11am - 2pm \nDinner: M-Th 5pm - 11pm, Fri-Sat:5pm - 1am", 'jetpack' ),
'email' => null,
'showmap' => 0,
'apikey' => null,
'goodmap' => null,
);
}
/**
* Outputs the HTML for this widget.
*
* @param array $args An array of standard parameters for widgets in this theme.
* @param array $instance An array of settings for this widget instance.
*
* @return void Echoes it's output
**/
public function widget( $args, $instance ) {
$instance = wp_parse_args( $instance, $this->defaults() );
echo $args['before_widget']; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
if ( '' !== $instance['title'] ) {
echo $args['before_title'] . $instance['title'] . $args['after_title']; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
}
/**
* Fires at the beginning of the Contact Info widget, after the title.
*
* @module widgets
*
* @since 3.9.2
*/
do_action( 'jetpack_contact_info_widget_start' );
echo '';
if ( '' !== $instance['address'] ) {
$showmap = $instance['showmap'];
$goodmap = isset( $instance['goodmap'] ) ? $instance['goodmap'] : $this->has_good_map( $instance );
if ( $showmap && true === $goodmap ) {
/**
* Set a Google Maps API Key.
*
* @since 4.1.0
*
* @param string $api_key Google Maps API Key
*/
$api_key = apply_filters( 'jetpack_google_maps_api_key', $instance['apikey'] );
echo $this->build_map( $instance['address'], $api_key ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
} elseif ( $showmap && is_customize_preview() && true !== $goodmap ) {
printf(
'
%s',
esc_html( $instance['goodmap'] )
);
}
$map_link = $this->build_map_link( $instance['address'] );
printf(
'
',
esc_url( $map_link ),
str_replace( "\n", '
', esc_html( $instance['address'] ) ) // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
);
}
if ( '' !== $instance['phone'] ) {
if ( wp_is_mobile() ) {
echo '
';
} else {
echo '
' . esc_html( $instance['phone'] ) . '
';
}
}
if ( is_email( trim( $instance['email'] ) ) ) {
printf(
'
',
esc_html( $instance['email'] )
);
}
if ( '' !== $instance['hours'] ) {
printf(
'
%s
',
str_replace( "\n", '
', esc_html( $instance['hours'] ) ) // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
);
}
echo '
/>
build_map( $instance['address'], $apikey ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
} elseif ( true !== $instance['goodmap'] && ! empty( $instance['goodmap'] ) ) {
printf(
'%s',
esc_html( $instance['goodmap'] )
);
}
?>
urlencode_address( $address );
}
/**
* Builds map display HTML code from the supplied address.
*
* @param string $address Address.
* @param string $api_key API Key.
*
* @return string HTML of the map.
*/
private function build_map( $address, $api_key = null ) {
$this->enqueue_scripts();
$src = add_query_arg( 'q', rawurlencode( $address ), 'https://www.google.com/maps/embed/v1/place' );
if ( ! empty( $api_key ) ) {
$src = add_query_arg( 'key', $api_key, $src );
}
$height = 216;
$iframe_attributes = sprintf(
' height="%d" frameborder="0" src="%s" title="%s" class="contact-map"',
esc_attr( $height ),
esc_url( $src ),
__( 'Google Map Embed', 'jetpack' )
);
$iframe_html = sprintf( '', $iframe_attributes );
if (
! class_exists( 'Jetpack_AMP_Support' )
|| ! Jetpack_AMP_Support::is_amp_request()
) {
return $iframe_html;
}
$amp_iframe_html = sprintf( '', $iframe_attributes );
// Add placeholder to avoid AMP error: elements must be positioned outside the first 75% of the viewport or 600px from the top (whichever is smaller).
$amp_iframe_html .= sprintf( '%s', esc_html__( 'Loading map…', 'jetpack' ) );
// Add original iframe as fallback in case JavaScript is disabled.
$amp_iframe_html .= sprintf( '', $iframe_html );
$amp_iframe_html .= '';
return $amp_iframe_html;
}
/**
* Encode an URL
*
* @param string $address The URL to encode.
*
* @return string The encoded URL
*/
private function urlencode_address( $address ) {
$address = strtolower( $address );
// Get rid of any unwanted whitespace.
$address = preg_replace( '/\s+/', ' ', trim( $address ) );
// Use + not %20.
$address = str_ireplace( ' ', '+', $address );
return rawurlencode( $address );
}
/**
* Returns the instance's updated 'goodmap' value.
*
* @param array $old_instance Old configuration values.
* @param array $instance Current configuration values.
*
* @return bool|string The instance's updated 'goodmap' value. The value is true if
* $instance can display a good map. If not, returns an error message.
*/
private function update_goodmap( $old_instance, $instance ) {
/*
* If we have no address or don't want to show a map,
* no need to check if the map is valid.
*/
if ( empty( $instance['address'] ) || 0 === $instance['showmap'] ) {
return false;
}
/*
* If there have been any changes that may impact the map in the widget
* (adding an address, address changes, new API key, API key change)
* then we want to check whether our map can be displayed again.
*/
if (
! isset( $instance['goodmap'] )
|| ! isset( $old_instance['address'] )
|| $this->urlencode_address( $old_instance['address'] ) !== $this->urlencode_address( $instance['address'] )
|| ! isset( $old_instance['apikey'] )
|| $old_instance['apikey'] !== $instance['apikey']
) {
return $this->has_good_map( $instance );
} else {
return $instance['goodmap'];
}
}
/**
* Check if the instance has a valid Map location.
*
* @param array $instance Widget instance configuration.
*
* @return bool|string Whether or not there is a valid map. If not, return an error message.
*/
private function has_good_map( $instance ) {
/** This filter is documented in modules/widgets/contact-info.php */
$api_key = apply_filters( 'jetpack_google_maps_api_key', $instance['apikey'] );
if ( ! empty( $api_key ) ) {
$path = add_query_arg(
array(
'q' => rawurlencode( $instance['address'] ),
'key' => $api_key,
),
'https://www.google.com/maps/embed/v1/place'
);
$wp_remote_get_args = array(
'headers' => array( 'Referer' => home_url() ),
);
$response = wp_remote_get( esc_url_raw( $path ), $wp_remote_get_args );
if ( 200 === wp_remote_retrieve_response_code( $response ) ) {
return true;
} else {
return wp_remote_retrieve_body( $response );
}
}
return __( 'Please enter a valid Google API Key.', 'jetpack' );
}
/**
* Check the Google Maps API key after an Ajax call from the widget's admin form in
* the Customizer preview.
*/
public function ajax_check_api_key() {
if ( isset( $_POST['apikey'] ) ) {
if ( check_ajax_referer( 'customize_contact_info_api_key' ) && current_user_can( 'customize' ) ) {
$apikey = wp_kses( wp_unslash( $_POST['apikey'] ), array() );
$default_instance = $this->defaults();
$default_instance['apikey'] = $apikey;
wp_send_json( array( 'result' => esc_html( $this->has_good_map( $default_instance ) ) ) );
}
} else {
wp_die();
}
}
}
}