acf_field_google_map{} │ ACF 1.0└─ acf_field
Использование
$acf_field_google_map = new acf_field_google_map();
// use class methods
Методы
- public initialize()
- public input_admin_enqueue_scripts()
- public render_field( $field )
- public render_field_settings( $field )
- public load_value( $value, $post_id, $field )
- public update_value( $value, $post_id, $field )
- public get_rest_schema( array $field )
- public format_value_for_rest( $value, $post_id, array $field )
- public get_jsonld_output_types()
- public format_value_for_jsonld( $value, $post_id, $field )
- private format_geo_coordinates( $value )
- private format_postal_address( $value )
- private format_place( $value )
Код acf_field_google_map{} acf field google map{}
ACF 6.8.8
<?php
class acf_field_google_map extends acf_field {
/**
* This function will setup the field type data
*
* @type function
* @date 5/03/2014
* @since 5.0.0
*
* @param n/a
* @return n/a
*/
function initialize() {
// vars
$this->name = 'google_map';
$this->label = __( 'Google Map', 'acf' );
$this->category = 'advanced';
$this->description = __( 'An interactive UI for selecting a location using Google Maps. Requires a Google Maps API key and additional configuration to display correctly.', 'acf' );
$this->preview_image = acf_get_url() . '/assets/images/field-type-previews/field-preview-google-map.png';
$this->doc_url = acf_add_url_utm_tags( 'https://www.advancedcustomfields.com/resources/google-map/', 'docs', 'field-type-selection' );
$this->defaults = array(
'height' => '',
'center_lat' => '',
'center_lng' => '',
'zoom' => '',
);
$this->default_values = array(
'height' => '400',
'center_lat' => '-37.81411',
'center_lng' => '144.96328',
'zoom' => '14',
);
}
/**
* description
*
* @type function
* @date 16/12/2015
* @since 5.3.2
*
* @param $post_id (int)
* @return $post_id (int)
*/
function input_admin_enqueue_scripts() {
// localize
acf_localize_text(
array(
'Sorry, this browser does not support geolocation' => __( 'Sorry, this browser does not support geolocation', 'acf' ),
)
);
// bail early if no enqueue
if ( ! acf_get_setting( 'enqueue_google_maps' ) ) {
return;
}
// vars
$api = array(
'key' => acf_get_setting( 'google_api_key' ),
'client' => acf_get_setting( 'google_api_client' ),
'libraries' => 'places',
'ver' => 3,
'callback' => 'Function.prototype',
'language' => acf_get_locale(),
);
// filter
$api = apply_filters( 'acf/fields/google_map/api', $api );
// remove empty
if ( empty( $api['key'] ) ) {
unset( $api['key'] );
}
if ( empty( $api['client'] ) ) {
unset( $api['client'] );
}
// construct url
$url = add_query_arg( $api, 'https://maps.googleapis.com/maps/api/js' );
// localize
acf_localize_data(
array(
'google_map_api' => $url,
)
);
}
/**
* Create the HTML interface for your field
*
* @param $field - an array holding all the field's data
*
* @type action
* @since 3.6
* @date 23/01/13
*/
function render_field( $field ) {
// Apply defaults.
foreach ( $this->default_values as $k => $v ) {
if ( ! $field[ $k ] ) {
$field[ $k ] = $v;
}
}
// Attrs.
$attrs = array(
'id' => $field['id'],
'class' => "acf-google-map {$field['class']}",
'data-lat' => $field['center_lat'],
'data-lng' => $field['center_lng'],
'data-zoom' => $field['zoom'],
);
$search = '';
if ( $field['value'] ) {
$attrs['class'] .= ' -value';
$search = $field['value']['address'];
} else {
$field['value'] = '';
}
?>
<div <?php echo acf_esc_attrs( $attrs ); ?>>
<?php
acf_hidden_input(
array(
'name' => $field['name'],
'value' => $field['value'],
)
);
?>
<div class="title">
<input class="search" type="text" placeholder="<?php esc_attr_e( 'Search for address...', 'acf' ); ?>" value="<?php echo esc_attr( $search ); ?>" />
<div class="acf-actions -hover">
<button type="button" data-name="search" class="acf-icon -search grey" aria-label="<?php esc_attr_e( 'Search', 'acf' ); ?>"></button>
<button type="button" data-name="clear" class="acf-icon -cancel grey" aria-label="<?php esc_attr_e( 'Clear location', 'acf' ); ?>"></button>
<button type="button" data-name="locate" class="acf-icon -location grey" aria-label="<?php esc_attr_e( 'Find current location', 'acf' ); ?>"></button>
</div>
<i class="acf-loading"></i>
</div>
<div class="canvas" style="<?php echo esc_attr( 'height: ' . $field['height'] . 'px' ); ?>"></div>
</div>
<?php
}
/**
* Create extra options for your field. This is rendered when editing a field.
* The value of $field['name'] can be used (like bellow) to save extra data to the $field
*
* @type action
* @since 3.6
* @date 23/01/13
*
* @param $field - an array holding all the field's data
*/
function render_field_settings( $field ) {
// center_lat
acf_render_field_setting(
$field,
array(
'label' => __( 'Center', 'acf' ),
'hint' => __( 'Center the initial map', 'acf' ),
'type' => 'text',
'name' => 'center_lat',
'prepend' => 'lat',
'placeholder' => $this->default_values['center_lat'],
)
);
// center_lng
acf_render_field_setting(
$field,
array(
'label' => __( 'Center', 'acf' ),
'hint' => __( 'Center the initial map', 'acf' ),
'type' => 'text',
'name' => 'center_lng',
'prepend' => 'lng',
'placeholder' => $this->default_values['center_lng'],
'_append' => 'center_lat',
)
);
// zoom
acf_render_field_setting(
$field,
array(
'label' => __( 'Zoom', 'acf' ),
'instructions' => __( 'Set the initial zoom level', 'acf' ),
'type' => 'text',
'name' => 'zoom',
'placeholder' => $this->default_values['zoom'],
)
);
// allow_null
acf_render_field_setting(
$field,
array(
'label' => __( 'Height', 'acf' ),
'instructions' => __( 'Customize the map height', 'acf' ),
'type' => 'text',
'name' => 'height',
'append' => 'px',
'placeholder' => $this->default_values['height'],
)
);
}
/**
* load_value
*
* Filters the value loaded from the database.
*
* @date 16/10/19
* @since 5.8.1
*
* @param mixed $value The value loaded from the database.
* @param mixed $post_id The post ID where the value is saved.
* @param array $field The field settings array.
* @return (array|false)
*/
function load_value( $value, $post_id, $field ) {
// Ensure value is an array.
if ( $value ) {
return wp_parse_args(
$value,
array(
'address' => '',
'lat' => 0,
'lng' => 0,
)
);
}
// Return default.
return false;
}
/**
* This filter is appied to the $value before it is updated in the db
*
* @type filter
* @since 3.6
* @date 23/01/13
*
* @param $value - the value which will be saved in the database
* @param $post_id - the post_id of which the value will be saved
* @param $field - the field array holding all the field options
*
* @return $value - the modified value
*/
function update_value( $value, $post_id, $field ) {
// decode JSON string.
if ( is_string( $value ) ) {
$value = json_decode( wp_unslash( $value ), true );
}
// Ensure value is an array.
if ( $value ) {
return (array) $value;
}
// Return default.
return false;
}
/**
* Return the schema array for the REST API.
*
* @param array $field
* @return array
*/
public function get_rest_schema( array $field ) {
return array(
'type' => array( 'object', 'null' ),
'required' => ! empty( $field['required'] ),
'properties' => array(
'address' => array(
'type' => 'string',
),
'lat' => array(
'type' => array( 'string', 'float' ),
),
'lng' => array(
'type' => array( 'string', 'float' ),
),
'zoom' => array(
'type' => array( 'string', 'int' ),
),
'place_id' => array(
'type' => 'string',
),
'name' => array(
'type' => 'string',
),
'street_number' => array(
'type' => array( 'string', 'int' ),
),
'street_name' => array(
'type' => 'string',
),
'street_name_short' => array(
'type' => 'string',
),
'city' => array(
'type' => 'string',
),
'state' => array(
'type' => 'string',
),
'state_short' => array(
'type' => 'string',
),
'post_code' => array(
'type' => array( 'string', 'int' ),
),
'country' => array(
'type' => 'string',
),
'country_short' => array(
'type' => 'string',
),
),
);
}
/**
* Apply basic formatting to prepare the value for default REST output.
*
* @param mixed $value
* @param string|integer $post_id
* @param array $field
* @return mixed
*/
public function format_value_for_rest( $value, $post_id, array $field ) {
if ( ! $value ) {
return null;
}
return acf_format_numerics( $value );
}
/**
* Returns an array of JSON-LD Property output types that are supported by this field type.
*
* @since 6.8
*
* @return string[]
*/
public function get_jsonld_output_types(): array {
return array( 'Place', 'GeoCoordinates', 'PostalAddress' );
}
/**
* Formats the field value for JSON-LD output.
*
* @since 6.8.0
*
* @param mixed $value The value of the field.
* @param integer|string $post_id The ID of the post.
* @param array $field The field array.
* @return mixed
*/
public function format_value_for_jsonld( $value, $post_id, $field ) {
if ( empty( $value ) || ! is_array( $value ) ) {
return null;
}
// Get output format with fallback.
$output_format = $field['schema_output_format'] ?? '';
if ( empty( $output_format ) ) {
$property = $field['schema_property'] ?? '';
$output_format = \ACF\AI\GEO\Schema::get_default_output_format( $this->name, $property );
}
// Default to Place if no format determined.
if ( empty( $output_format ) ) {
$output_format = 'Place';
}
switch ( $output_format ) {
case 'GeoCoordinates':
return $this->format_geo_coordinates( $value );
case 'PostalAddress':
return $this->format_postal_address( $value );
case 'Place':
default:
return $this->format_place( $value );
}
}
/**
* Format value as GeoCoordinates.
*
* @since 6.8.0
*
* @param array $value The google map value array.
* @return array|null
*/
private function format_geo_coordinates( $value ) {
if ( empty( $value['lat'] ) || empty( $value['lng'] ) ) {
return null;
}
return array(
'@type' => 'GeoCoordinates',
'latitude' => (float) $value['lat'],
'longitude' => (float) $value['lng'],
);
}
/**
* Format value as PostalAddress.
*
* @since 6.8.0
*
* @param array $value The google map value array.
* @return array|null
*/
private function format_postal_address( $value ) {
$address = array(
'@type' => 'PostalAddress',
);
// Build street address from components.
$street_parts = array();
if ( ! empty( $value['street_number'] ) ) {
$street_parts[] = $value['street_number'];
}
if ( ! empty( $value['street_name'] ) ) {
$street_parts[] = $value['street_name'];
}
if ( ! empty( $street_parts ) ) {
$address['streetAddress'] = implode( ' ', $street_parts );
}
if ( ! empty( $value['city'] ) ) {
$address['addressLocality'] = $value['city'];
}
if ( ! empty( $value['state'] ) ) {
$address['addressRegion'] = $value['state'];
}
if ( ! empty( $value['post_code'] ) ) {
$address['postalCode'] = (string) $value['post_code'];
}
if ( ! empty( $value['country'] ) ) {
$address['addressCountry'] = $value['country'];
}
// Only return if we have at least one address property beyond @type.
if ( count( $address ) > 1 ) {
return $address;
}
return null;
}
/**
* Format value as Place.
*
* @since 6.8.0
*
* @param array $value The google map value array.
* @return array|null
*/
private function format_place( $value ) {
$place = array(
'@type' => 'Place',
);
// Add name if available.
if ( ! empty( $value['name'] ) ) {
$place['name'] = $value['name'];
}
// Add full address as formatted string.
if ( ! empty( $value['address'] ) ) {
$place['address'] = $value['address'];
}
// Add geo coordinates.
$geo = $this->format_geo_coordinates( $value );
if ( $geo ) {
$place['geo'] = $geo;
}
// Only return if we have meaningful data beyond @type.
if ( count( $place ) > 1 ) {
return $place;
}
return null;
}
}
