Atención: el MMPAPI se ha eliminado con v4.0, reemplazo: API de base de datos

Documentación MMPAPI

volver a la descripción general de la API

Funciones MMPAPI

  1. Introducción
  2. descripción de clase generada
  3. Marcadores
    1. add_marker
    2. add_markers
    3. count_markers
    4. delete_marker
    5. delete_markers
    6. get_marker
    7. get_markers
    8. list_markers
    9. search_markers
    10. update_marker
    11. update_markers
  4. capas
    1. add_layer
    2. add_layers
    3. cuenta_capas
    4. delete_layer
    5. delete_layers
    6. get_layer
    7. get_layers
    8. list_layers
    9. buscar_capas
    10. update_layer
    11. update_layers
  5. Permissions
    1. current_user_can_any
  6. parámetros
    1. Parámetros disponibles para marcador de tipo
    2. Parámetros disponibles para la capa de tipo
    3. Parámetros especiales para la acción de la lista de marcadores
    4. Parámetros especiales para la acción de la lista de capas.
    5. Parámetros especiales para la acción de búsqueda.


Introducción

Las funciones de API de Maps Marker Pro proporcionan a los desarrolladores una forma a prueba de futuro para acceder a algunas de las funcionalidades principales comunes en Maps Marker Pro.

Las funciones de API se incluyen automáticamente cuando se carga Maps Marker Pro y estarán disponibles para cuando se carguen los complementos. La clase API se llama MMPAPI y se puede encontrar en /leaflet-maps-marker-pro/inc/class-mmpapi.php.


Descripción de clase generada

La descripción de clase generada automáticamente se puede encontrar en https://www.mapsmarker.com/wp-content/uploads/mmpapi/class/


Marcadores

add_marker

Agrega un nuevo marcador usando el objeto Marcador dado. Advertencia, se realiza una pequeña comprobación para asegurarse de que sea un objeto Marker válido.

public static function add_marker( $marker_data ) {}

parámetros

Devoluciones

Ejemplo de uso


$marker_data = array(
	'markername' => 'Headquarter',
	'geocode' => 'Main Street 1 Washington',
);
$marker_id = MMPAPI::add_marker( $marker_data );
volver al inicio


add_markers

Agregar marcadores basados ​​en objetos de datos dados.

public static function add_markers( $markers_data ) {}

parámetros

Devoluciones

  • $ marcadores mezclado

    Una matriz de ID de marcadores u objeto WP_Error.

Ejemplo de uso


$markers_data = array(
	array(
		'markername' => 'Headquarter',
		'geocode' => 'Main Street 1 Washington',
	),
	array(
		'markername' => 'Headquarter',
		'geocode' => 'Main Street 1 Washington',
	));
$markers = MMPAPI::add_markers( $markers_data );
volver al inicio


count_markers

Devuelve el número de marcadores disponibles.

public static function count_markers( ) {}

Devoluciones

  • $ markers_count int

    Los marcadores cuentan

Ejemplo de uso

$result = MMPAPI::count_markers( );
volver al inicio


delete_marker

Elimina el marcador con la ID de marcador dada.

public static function delete_marker( $marker_id ) {}

parámetros

  • $ marker_id entero

    La identificación del marcador que se eliminará.

Devoluciones

Ejemplo de uso

$result = MMPAPI::delete_marker( $marker_id );
volver al inicio


delete_markers

Elimina los marcadores para una ID de marcadores determinada

public static function delete_markers( $marker_ids ) {}

parámetros

  • $ marker_ids matriz

    Las identificaciones de los marcadores.

Devoluciones

  • $ resultado mezclado

    Verdadero si los marcadores se eliminaron correctamente, WP_Error objetar si no.

Ejemplo de uso


$marker_ids = array(6,7,8);
$result = MMPAPI::delete_markers( $marker_ids );
volver al inicio


get_marker

Devuelve el objeto marcador para una ID de marcador determinada.

public static function get_marker( $marker_id ) {}

parámetros

  • $ marker_id entero

    La identificación del marcador.

Devoluciones

  • $ resultado mezclado

    El objeto marcador o Falso.

Ejemplo de uso

$result = MMPAPI::get_marker( 5 );
volver al inicio


get_markers

Devuelve los objetos marcadores para identificadores de marcador dados.

public static function get_markers( $marker_ids ) {}

parámetros

  • $ marker_ids matriz

    Las identificaciones de los marcadores.

Devoluciones

  • $ resultado mezclado

    El marcador se opone o Falso.

Ejemplo de uso

$result = MMPAPI::get_markers( array( 1, 5, 10 ) );
volver al inicio


list_markers

Devuelve todos los objetos marcadores.

public static function list_markers( $args = NULL ){}

parámetros

Devoluciones

  • $ resultado mezclado

    El marcador se opone o Falso.

Ejemplo de uso


$args['orderkey'] = 'markername';
$args['orderdir'] = 'ASC';
$result = MMPAPI::list_markers( $args );
volver al inicio


search_markers

Los objetos de marcadores de búsqueda para un argumento dado.

public static function search_markers( $args ) {}

parámetros

Devoluciones

  • $ resultado mezclado

    Los objetos marcadores que coinciden con los parámetros o False.

Ejemplo de uso


$args['searchkey'] = 'layer';
$args['searchvalue'] = 7;
$result = MMPAPI::search_markers( $args );
volver al inicio


update_marker

Actualiza un marcador basado en un objeto de datos dado

public static function update_marker( $marker_data ) {}

parámetros

Devoluciones

  • $ resultado booleano

    Verdadero si el marcador se ha actualizado, falso de lo contrario.

Ejemplo de uso


$marker_data = array(
					 'id' => 2,
					 'popuptext' => 'new popuptext' 
					 );

$result = MMPAPI::update_marker( $marker_data );
volver al inicio


update_markers

Actualizar marcadores basados ​​en un objeto de datos dado

public static function update_markers( $markers_data ) {}

parámetros

Devoluciones

  • $ resultado mezclado

    Matriz de ID de marcadores actualizados o un objeto de error.

Ejemplo de uso


$markers_data = array(
					array(
					 	'id' => 2,
					 	'popuptext' => 'new popuptext for marker#2' 
					 ),
					 array(
					 	'id' => 3,
					 	'popuptext' => 'new popuptext for marker#3' 
					 )
				);

$result = MMPAPI::update_markers( $markers_data );
volver al inicio


capas

add_layer

Agrega una nueva capa usando el objeto Layer dado. Advertencia, se realiza una pequeña comprobación para asegurarse de que sea un objeto de capa válido.

public static function add_layer( $layer_data ) {}

parámetros

Devoluciones

Ejemplo de uso


$layer_data = array(
	'name' => 'Headquarter',
	'geocode' => 'Main Street 1 Washington',
);
$layer_id = MMPAPI::add_layer( $layer_data );
volver al inicio


add_layers

Agregar capas basadas en objetos de datos dados.

public static function add_layers( $layers_data ) {}

parámetros

Devoluciones

  • $ capas mezclado

    Una matriz de ID de capas u objeto WP_Error.

Ejemplo de uso


$layers_data = array(
	array(
		'name' => 'Headquarter',
		'geocode' => 'Main Street 1 Washington',
	),
	array(
		'name' => 'Headquarter 2',
		'geocode' => 'Main Street 2 Washington',
	));
$layers = MMPAPI::add_layers( $layers_data );
volver al inicio


cuenta_capas

Devuelve el número de capas disponibles.

public static function count_layers( ) {}

Devoluciones

  • $ layers_count int

    Las capas cuentan

Ejemplo de uso

$result = MMPAPI::count_layers( );
volver al inicio


delete_layer

Elimina la capa con la ID de capa dada.

public static function delete_layer( $layer_id, $delete_markers = false ) {}

parámetros

  • $ layer_id entero

    El ID de la capa que se va a eliminar.

  • $ delete_markers booleano

    Un parámetro booleano, si se ha establecido en VERDADERO, el método eliminará todos los marcadores asociados con la capa. El valor predeterminado es FALSO.

Devoluciones

Ejemplo de uso

$result = MMPAPI::delete_layer( $layer_id );
volver al inicio


delete_layers

Elimina las capas para una ID de capas dada

public static function delete_layers( $layers_ids, $delete_markers = false ) {}

parámetros

  • $ layers_ids matriz

    Las identificaciones de las capas.

  • $ delete_markers booleano

    Un parámetro booleano, si se ha establecido en VERDADERO, el método eliminará todos los marcadores asociados con las capas. El valor predeterminado es FALSO.

Devoluciones

  • $ resultado mezclado

    Verdadero si las capas se eliminan correctamente WP_Error objetar si no.

Ejemplo de uso


$layers_ids = array(6,7,8);
$result = MMPAPI::delete_layers( $layers_ids );
volver al inicio


get_layer

Devuelve el objeto de capa para una ID de capa dada.

public static function get_layer( $layer_id ) {}

parámetros

  • $ layer_id entero

    La identificación de la capa.

Devoluciones

  • $ resultado mezclado

    El objeto de capa o Falso.

Ejemplo de uso

$result = MMPAPI::get_layer( 5 );
volver al inicio


get_layers

Devuelve los objetos de capa para los ID de capa dados.

public static function get_layers( $layer_ids ) {}

parámetros

  • $ layer_ids matriz

    Las identificaciones de las capas.

Devoluciones

  • $ resultado mezclado

    Los objetos de capa o Falso.

Ejemplo de uso

$result = MMPAPI::get_layers( array( 1, 5, 10 ) );
volver al inicio


list_layers

Devuelve todos los objetos de capa.

public static function list_layers( $args = NULL ) {}

parámetros

Devoluciones

  • $ resultado mezclado

    Los objetos de capa o Falso.

Ejemplo de uso


$args['orderkey'] = 'name';
$args['orderdir'] = 'ASC';
$result = MMPAPI::list_layers( $args );
volver al inicio


buscar_capas

Buscar objetos de capas para un argumento dado.

public static function search_layers( $args ) {}

parámetros

Devoluciones

  • $ resultado mezclado

    Los objetos de capas que coinciden con los parámetros o False.

Ejemplo de uso


$args['searchkey'] = 'name';
$args['searchvalue'] = 'Washington';
$result = MMPAPI::search_layers( $args );
volver al inicio


update_layer

Actualiza una capa basada en un objeto de datos dado

public static function update_layer( $layer_data ) {}

parámetros

Devoluciones

  • $ resultado booleano

    Verdadero si la capa se ha actualizado, falso de lo contrario.

Ejemplo de uso


$layer_data = array(
					 'id' => 2,
					 'popuptext' => 'new popuptext' 
					 );

$result = MMPAPI::update_layer( $layer_data );
volver al inicio


update_layers

Actualizar capas basadas en un objeto de datos dado

public static function update_layers( $layers_data ) {}

parámetros

Devoluciones

  • $ resultado mezclado

    Matriz de ID de capas actualizadas o un objeto de error.

Ejemplo de uso


// Update layers with IDs 2,3 hide list of markers below map 
$layers_data = array(
					array(
					 	'id' => 2,
					 	'listmarkers' => 0
					 ),
					 array(
					 	'id' => 3,
					 	'listmarkers' => 0
					 )
				);

$result = MMPAPI::update_layers( $layers_data );
volver al inicio

Permissions

current_user_can_any

Comprueba los permisos para el usuario actual. Devuelve verdadero si el usuario actual tiene alguna de las capacidades especificadas.

IMPORTANTE: llame a esto antes de llamar a cualquiera de las otras funciones de API ya que las comprobaciones de permisos no se realizan en niveles inferiores.

public static function current_user_can_any( $capabilities ) {}

parámetros

  • $ capacidades mezclado

    Cadena si desea verificar solo una capacidad, o una matriz de múltiples capacidades

Devoluciones

Ejemplo de uso


$marker_data = array(
	'markername' => 'Headquarter',
	'geocode' => 'Main Street 1 Washington',
);
if(MMPAPI::current_user_can_any( 'edit_posts' )){
	$marker_id = MMPAPI::add_marker( $marker_data );
}else{
	wp_die('You do not have permessions');
}
volver al inicio


parámetros

Parámetros disponibles para marcador de tipo

Parámetro ¿Necesario? Tipo de datos Valor por defecto Notas
idson requeridosenteroestablecer automáticamente al agregar un nuevo marcador
nombre del marcadoropcionalcadenaNULL
geocódigoopcionalcadenaNULL el valor se geocodifica a través de la API de Google Places y sobrescribe el parámetro lat, lon y address
mapa base opcional ID de mapas base predefinidos - ver notas mapa base predeterminado para el nuevo marcador (ver configuración) osm_mapnik, mapquest_osm, mapquest_aerial, googleLayer_roadmap, googleLayer_satellite, googleLayer_hybrid, googleLayer_terrain, bingaerial, bingaerialwithlabels, bingroad, ogdwien_basemap, ogdwien_satellite, mapbox, mapbase_base_2 personalizado, mapa_base_3 personalizado, mapa_base2, mapa_base, personalizado_base, mapa_3, base de datos personalizadas, mapa_XNUMX, base de datos personalizadas, mapa_XNUMX, base de datos personalizadas, mapa_XNUMX, base de datos personalizadas, mapa_XNUMX, base de datos personalizadas, mapa_XNUMX, base de datos personalizadas.
. opcional entero capa predeterminada para el nuevo marcador (ver configuración)
latopcionalflotarubicación predeterminada para el nuevo marcador (ver configuración) se sobrescribe si se usa el parámetro geocode!
lonopcionalflotarubicación predeterminada para el nuevo marcador (ver configuración) se sobrescribe si se usa el parámetro geocode!
iconopcionalcadena (por ejemplo, bus.png)NULL si es NULL, se usará el icono predeterminado. Simplemente use el nombre de archivo del icono como se indica en el ejemplo. Todos los íconos disponibles en el directorio de íconos (generalmente / wp-content / uploads / leaflet-maps-marker-icons si no lo cambió en Configuración / valores predeterminados del mapa / Valores predeterminados para los íconos de marcador) están disponibles para su uso.
texto emergenteopcionalcadenaNULL
zoomopcionalenterozoom predeterminado para el nuevo marcador (ver configuración)
abrir popupopcionalbooleanovalor predeterminado para nuevos marcadores (ver configuración)
ancho de mapaopcionalenteroancho de mapa predeterminado para nuevos marcadores (ver configuración)
mapwidthunitopcionalcadenavalor predeterminado para nuevos marcadores (ver configuración)
altura del mapaopcionalenteroaltura de mapa predeterminada para nuevos marcadores (ver configuración)
panelopcionalbooleanovalor predeterminado para nuevos marcadores (ver configuración)
creado poropcionalcadenaNULL
creado enopcionalfecha (Ymd H: i: s)NULL
Actualizado poropcionalcadenaNULL
actualizado enopcionalfecha (Ymd H: i: s)fecha ('Ymd H: i: s)
caja de controlopcionalbooleanovalor predeterminado para nuevos marcadores (ver configuración)
superposiciones_personalizadoopcionalbooleanovalor predeterminado para nuevos marcadores (ver configuración)
superposiciones_personalizado2opcionalbooleanovalor predeterminado para nuevos marcadores (ver configuración)
superposiciones_personalizado3opcionalbooleanovalor predeterminado para nuevos marcadores (ver configuración)
superposiciones_personalizado4opcionalbooleanovalor predeterminado para nuevos marcadores (ver configuración)
WMSopcionalbooleanovalor predeterminado para nuevos marcadores (ver configuración)
wms2opcionalbooleanovalor predeterminado para nuevos marcadores (ver configuración)
wms3opcionalbooleanovalor predeterminado para nuevos marcadores (ver configuración)
wms4opcionalbooleanovalor predeterminado para nuevos marcadores (ver configuración)
wms5opcionalbooleanovalor predeterminado para nuevos marcadores (ver configuración)
wms6opcionalbooleanovalor predeterminado para nuevos marcadores (ver configuración)
wms7opcionalbooleanovalor predeterminado para nuevos marcadores (ver configuración)
wms8opcionalbooleanovalor predeterminado para nuevos marcadores (ver configuración)
wms9opcionalbooleanovalor predeterminado para nuevos marcadores (ver configuración)
wms10opcionalbooleanovalor predeterminado para nuevos marcadores (ver configuración)
kml_timestampopcionalfecha (Ymd H: i: s)NULL
direcciónopcionalcadenaNULL se sobrescribe si se usa el parámetro geocode!
gpx_urlopcionalcadenaNULL desde v1.2p
gpx_panelopcionalbooleano0 desde v1.2p

volver al inicio


Parámetros disponibles para la capa de tipo

Parámetro ¿Necesario? Tipo de datos Valor por defecto Notas
idson requeridosenteroestablecer automáticamente al agregar un nuevo marcador
geocódigoopcionalcadenaNULL el valor se geocodifica a través de la API de Google Places y sobrescribe el parámetro lat, lon y address
nombre opcionalcadenaNULL
mapa baseopcionalvalores predefinidosmapa base predeterminado para la nueva capa (ver configuración) osm_mapnik, mapquest_osm, mapquest_aerial, googleLayer_roadmap, googleLayer_satellite, googleLayer_hybrid, googleLayer_terrain, bingaerial, bingaerialwithlabels, bingroad, ogdwien_basemap, ogdwien_satellite, mapbox, mapbase_base_2 personalizado, mapa_base_3 personalizado, mapa_base2, mapa_base, personalizado_base, mapa_3, base de datos personalizadas, mapa_XNUMX, base de datos personalizadas, mapa_XNUMX, base de datos personalizadas, mapa_XNUMX, base de datos personalizadas, mapa_XNUMX, base de datos personalizadas, mapa_XNUMX, base de datos personalizadas.
layerzoomopcionalenterozoom predeterminado para nueva capa (ver configuración)
mapwidthunitopcionalcadenavalor predeterminado para la nueva capa (ver configuración)
ancho de mapaopcionalenteroancho de mapa predeterminado para la nueva capa (ver configuración)
altura del mapaopcionalenteroaltura de mapa predeterminada para la nueva capa (ver configuración)
panelopcionalbooleanovalor predeterminado para la nueva capa (ver configuración)
layerviewlatopcionalflotarlat predeterminado para la nueva capa (ver configuración) se sobrescribe si se usa el parámetro geocode!
layerviewlonopcionalflotarLon predeterminado para la nueva capa (ver configuración) se sobrescribe si se usa el parámetro geocode!
creado poropcionalcadenaNULL
creado enopcionalfecha (Ymd H: i: s)NULL
Actualizado poropcionalcadenaNULL
actualizado enopcionalfecha (Ymd H: i: s)fecha ('Ymd H: i: s)
caja de controlopcionalbooleanovalor predeterminado para la nueva capa (ver configuración)
superposiciones_personalizadoson requeridosbooleanovalor predeterminado para la nueva capa (ver configuración)
superposiciones_personalizado2son requeridosbooleanovalor predeterminado para la nueva capa (ver configuración)
superposiciones_personalizado3son requeridosbooleanovalor predeterminado para la nueva capa (ver configuración)
superposiciones_personalizado4son requeridosbooleanovalor predeterminado para la nueva capa (ver configuración)
WMSson requeridosbooleanovalor predeterminado para la nueva capa (ver configuración)
wms2son requeridosbooleanovalor predeterminado para la nueva capa (ver configuración)
wms3son requeridosbooleanovalor predeterminado para la nueva capa (ver configuración)
wms4son requeridosbooleanovalor predeterminado para la nueva capa (ver configuración)
wms5son requeridosbooleanovalor predeterminado para la nueva capa (ver configuración)
wms6son requeridosbooleanovalor predeterminado para la nueva capa (ver configuración)
wms7son requeridosbooleanovalor predeterminado para la nueva capa (ver configuración)
wms8son requeridosbooleanovalor predeterminado para la nueva capa (ver configuración)
wms9son requeridosbooleanovalor predeterminado para la nueva capa (ver configuración)
wms10son requeridosbooleanovalor predeterminado para la nueva capa (ver configuración)
marcadores de listaopcionalbooleanovalor predeterminado para la nueva capa (ver configuración) opción para mostrar la lista de marcadores debajo de los mapas de capa
multi_layer_mapopcionalbooleano0
lista_mapa_múltiples capasopcionalcadena (ID de capa separados por comas o todo)NULL por ejemplo 1,2,3,4 o todos
direcciónopcionalcadenaNULL se sobrescribe si se usa el parámetro geocode!
delete_markersopcionalverdadero / falsofalse cuando se usa en la acción de eliminación, también se eliminan los marcadores asignados
clusteringopcionalbooleanovalor predeterminado para la nueva capa (ver configuración) disponible solo en versión pro
gpx_urlopcionalcadenaNULL desde v1.2p
gpx_panelopcionalbooleano0 desde v1.2p


Parámetros especiales para la acción de la lista de marcadores

Parámetro¿Necesario?Tipo de datosNotas
clave de pedidoopcionalcadenaValores de orden de clasificación permitidos: id, createdon, updatedon, kml_timestamp, markername, basemap, lat, lon, createdby, updatedby, address
orderdiropcionalcadenaValores de dirección de clasificación permitidos: ASC, DESC
ordenopcionalenteroDesplazamiento para la lista de marcadores
orden limitadaopcionalenteroLímite para la lista de marcadores
volver al inicio


Parámetros especiales para la acción de la lista de capas.

Parámetro¿Necesario?Tipo de datosNotas
clave de pedidoopcionalcadenaValores de orden de clasificación permitidos: id, updatedon, createdon, name, basemap, layerviewlat, layerviewlon, createdby, updatedby, address
orderdiropcionalcadenaValores de dirección de clasificación permitidos: ASC, DESC
ordenopcionalenteroDesplazamiento para la lista de capas
orden limitadaopcionalenteroLímite para la lista de capas
volver al inicio


Parámetros especiales para la acción de búsqueda.

Parámetro¿Necesario?Tipo de datosNotas
clave de búsquedason requeridoscadenaTeclas de búsqueda permitidas: id, nombre de marcador, mapa base, capa, lat, lon, icono, texto emergente, zoom, ventana abierta, ancho de mapa, unidad de ancho de mapa, altura de mapa, panel, createdby, createdon, updatedby, updatedon, controlbox, overlays_custom, overlays_custom2, overlays_custom3, overlays_custom4, wms , wms2, wms3, wms4, wms5, wms6, wms7, wms8, wms9, wms10, kml_timestamp, address, gpx_url, gpx_panel, name, layerzoom, layerviewlat, layerviewlon, listmarkers, multi_layer_map, multi_layer_map_listing, clustering, clustering, clustering
valor de búsquedadependecadena o enterogeneralmente es obligatorio pero opcional cuando se usa la tecla de búsqueda creada en, actualizada en o cuadro de límite
fecha dedependecadena (Ymd H: i: s)generalmente opcional pero obligatorio cuando se usa la tecla de búsqueda creada o actualizada
date_todependecadena (Ymd H: i: s)generalmente opcional pero obligatorio cuando se usa la tecla de búsqueda creada o actualizada
lat_top_leftdependeflotante (6)generalmente opcional pero requerido cuando se usa la búsqueda keyingbox
lon_top_leftdependeflotante (6)generalmente opcional pero requerido cuando se usa la búsqueda keyingbox
lat_bottom_rightdependeflotante (6)generalmente opcional pero requerido cuando se usa la búsqueda keyingbox
lon_bottom_rightdependeflotante (6)generalmente opcional pero requerido cuando se usa la búsqueda keyingbox
volver al inicio