Attentation: o MMPAPI foi removido com v4.0, substituição: API de banco de dados

Documentação MMPAPI

voltar à visão geral da API

Funções MMPAPI

  1. Introdução
  2. descrição da classe gerada
  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. marcadores de pesquisa
    10. update_marker
    11. update_markers
  4. Camadas
    1. add_layer
    2. add_layers
    3. count_layers
    4. delete_layer
    5. delete_layers
    6. get_layer
    7. get_layers
    8. list_layers
    9. search_layers
    10. update_layer
    11. update_layers
  5. Permissões
    1. current_user_can_any
  6. parâmetros
    1. Parâmetros disponíveis para o marcador de tipo
    2. Parâmetros disponíveis para a camada de tipos
    3. Parâmetros especiais para ação da lista de marcadores
    4. Parâmetros especiais para ação da lista de camadas
    5. Parâmetros especiais para ação de pesquisa


Introdução

As funções da API do Maps Marker Pro fornecem aos desenvolvedores uma maneira preparada para o futuro de acessar algumas das principais funcionalidades comuns do Maps Marker Pro.

As funções da API são incluídas automaticamente quando o Maps Marker Pro é carregado e estarão disponíveis quando os complementos forem carregados. A classe da API é chamada MMPAPI e pode ser encontrada em /leaflet-maps-marker-pro/inc/class-mmpapi.php.


Descrição da classe gerada

A descrição da classe gerada automaticamente pode ser encontrada em https://www.mapsmarker.com/wp-content/uploads/mmpapi/class/


Marcadores

add_marker

Adiciona um novo marcador usando o objeto Marcador fornecido. Atenção, pouca verificação é feita para garantir que seja um objeto Marcador válido.

public static function add_marker( $marker_data ) {}

parâmetros

Política de devolução

  • resultado $ misto

    O ID do marcador (int) ou um WP_Error instância.

Exemplo de uso


$marker_data = array(
	'markername' => 'Headquarter',
	'geocode' => 'Main Street 1 Washington',
);
$marker_id = MMPAPI::add_marker( $marker_data );
de volta ao topo


add_markers

Adicione marcadores com base em objetos de dados fornecidos.

public static function add_markers( $markers_data ) {}

parâmetros

Política de devolução

  • $ marcadores misto

    Uma matriz de IDs de marcadores ou objeto WP_Error.

Exemplo 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 );
de volta ao topo


count_markers

Retorna o número de marcadores disponíveis.

public static function count_markers( ) {}

Política de devolução

  • $ markers_count int

    Os marcadores contam

Exemplo de uso

$result = MMPAPI::count_markers( );
de volta ao topo


delete_marker

Exclui o marcador com o ID do marcador fornecido.

public static function delete_marker( $marker_id ) {}

parâmetros

Política de devolução

  • resultado $ misto

    Verdadeiro para o sucesso ou um WP_Error instância.

Exemplo de uso

$result = MMPAPI::delete_marker( $marker_id );
de volta ao topo


delete_markers

Exclui os marcadores para uma determinada identificação de marcadores

public static function delete_markers( $marker_ids ) {}

parâmetros

  • $ marker_ids ordem

    Os IDs dos marcadores.

Política de devolução

  • resultado $ misto

    Verdadeiro se os marcadores foram excluídos com sucesso, WP_Error objeto, se não.

Exemplo de uso


$marker_ids = array(6,7,8);
$result = MMPAPI::delete_markers( $marker_ids );
de volta ao topo


get_marker

Retorna o objeto marcador para um determinado ID de marcador.

public static function get_marker( $marker_id ) {}

parâmetros

Política de devolução

  • resultado $ misto

    O objeto marcador ou False.

Exemplo de uso

$result = MMPAPI::get_marker( 5 );
de volta ao topo


get_markers

Retorna os objetos de marcador para os IDs de marcador fornecidos.

public static function get_markers( $marker_ids ) {}

parâmetros

  • $ marker_ids ordem

    Os IDs dos marcadores.

Política de devolução

  • resultado $ misto

    Os objetos do marcador ou Falso.

Exemplo de uso

$result = MMPAPI::get_markers( array( 1, 5, 10 ) );
de volta ao topo


list_markers

Retorna todos os objetos marcadores.

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

parâmetros

Política de devolução

  • resultado $ misto

    Os objetos do marcador ou Falso.

Exemplo de uso


$args['orderkey'] = 'markername';
$args['orderdir'] = 'ASC';
$result = MMPAPI::list_markers( $args );
de volta ao topo


marcadores de pesquisa

Os marcadores de pesquisa objetam um determinado argumento.

public static function search_markers( $args ) {}

parâmetros

Política de devolução

  • resultado $ misto

    Os objetos marcadores que correspondem aos parâmetros ou False.

Exemplo de uso


$args['searchkey'] = 'layer';
$args['searchvalue'] = 7;
$result = MMPAPI::search_markers( $args );
de volta ao topo


update_marker

Atualiza um marcador com base no objeto de dados especificado

public static function update_marker( $marker_data ) {}

parâmetros

Política de devolução

  • resultado $ booleano

    Verdadeiro se o marcador foi atualizado, caso contrário, falso.

Exemplo de uso


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

$result = MMPAPI::update_marker( $marker_data );
de volta ao topo


update_markers

Atualizar marcadores com base no objeto de dados fornecido

public static function update_markers( $markers_data ) {}

parâmetros

Política de devolução

  • resultado $ misto

    Matriz de IDs de marcadores atualizados ou um objeto de erro.

Exemplo 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 );
de volta ao topo


Camadas

add_layer

Adiciona uma nova camada usando o objeto Layer especificado. Atenção, pouca verificação é feita para garantir que seja um objeto de camada válido.

public static function add_layer( $layer_data ) {}

parâmetros

Política de devolução

  • resultado $ misto

    O ID da camada (int) ou um WP_Error instância.

Exemplo de uso


$layer_data = array(
	'name' => 'Headquarter',
	'geocode' => 'Main Street 1 Washington',
);
$layer_id = MMPAPI::add_layer( $layer_data );
de volta ao topo


add_layers

Adicione camadas com base em objetos de dados fornecidos.

public static function add_layers( $layers_data ) {}

parâmetros

Política de devolução

  • $ camadas misto

    Uma matriz de IDs de camadas ou objeto WP_Error.

Exemplo 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 );
de volta ao topo


count_layers

Retorna o número de camadas disponíveis.

public static function count_layers( ) {}

Política de devolução

  • $ layers_count int

    As camadas contam

Exemplo de uso

$result = MMPAPI::count_layers( );
de volta ao topo


delete_layer

Exclui a camada com o ID da camada fornecido.

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

parâmetros

  • $ layer_id número inteiro

    O ID da camada a ser excluída.

  • $ delete_markers booleano

    Um parâmetro booleano, se definido como TRUE, o método excluirá todos os marcadores associados à camada. O valor padrão é FALSE.

Política de devolução

  • resultado $ misto

    Verdadeiro para o sucesso ou um WP_Error instância.

Exemplo de uso

$result = MMPAPI::delete_layer( $layer_id );
de volta ao topo


delete_layers

Exclui as camadas de um determinado ID de camadas

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

parâmetros

  • $ layers_ids ordem

    Os IDs das camadas.

  • $ delete_markers booleano

    Um parâmetro booleano, se definido como TRUE, o método excluirá todos os marcadores associados às camadas. O valor padrão é FALSE.

Política de devolução

  • resultado $ misto

    Verdadeiro se as camadas foram excluídas com sucesso, WP_Error objeto, se não.

Exemplo de uso


$layers_ids = array(6,7,8);
$result = MMPAPI::delete_layers( $layers_ids );
de volta ao topo


get_layer

Retorna o objeto da camada para um determinado ID da camada.

public static function get_layer( $layer_id ) {}

parâmetros

Política de devolução

  • resultado $ misto

    O objeto de camada ou Falso.

Exemplo de uso

$result = MMPAPI::get_layer( 5 );
de volta ao topo


get_layers

Retorna os objetos da camada para determinados IDs da camada.

public static function get_layers( $layer_ids ) {}

parâmetros

  • $ layer_ids ordem

    Os IDs das camadas.

Política de devolução

  • resultado $ misto

    Os objetos da camada ou Falso.

Exemplo de uso

$result = MMPAPI::get_layers( array( 1, 5, 10 ) );
de volta ao topo


list_layers

Retorna todos os objetos da camada.

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

parâmetros

Política de devolução

  • resultado $ misto

    Os objetos da camada ou Falso.

Exemplo de uso


$args['orderkey'] = 'name';
$args['orderdir'] = 'ASC';
$result = MMPAPI::list_layers( $args );
de volta ao topo


search_layers

As camadas de pesquisa objetam um determinado argumento.

public static function search_layers( $args ) {}

parâmetros

Política de devolução

  • resultado $ misto

    Os objetos de camadas que correspondem aos parâmetros ou Falso.

Exemplo de uso


$args['searchkey'] = 'name';
$args['searchvalue'] = 'Washington';
$result = MMPAPI::search_layers( $args );
de volta ao topo


update_layer

Atualiza uma camada com base no objeto de dados especificado

public static function update_layer( $layer_data ) {}

parâmetros

Política de devolução

  • resultado $ booleano

    Verdadeiro se a camada tiver sido atualizada, caso contrário, falso.

Exemplo de uso


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

$result = MMPAPI::update_layer( $layer_data );
de volta ao topo


update_layers

Atualizar camadas com base no objeto de dados fornecido

public static function update_layers( $layers_data ) {}

parâmetros

Política de devolução

  • resultado $ misto

    Matriz de IDs de camadas atualizadas ou um objeto de erro.

Exemplo 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 );
de volta ao topo

Permissões

current_user_can_any

Verifica as permissões para o usuário atual. Retorna true se o usuário atual tiver algum dos recursos especificados.

IMPORTANTE: Ligue para isso antes de chamar qualquer uma das outras funções da API, pois as verificações de permissão não são executadas em níveis inferiores.

public static function current_user_can_any( $capabilities ) {}

parâmetros

  • $ capacidades misto

    Se você deseja verificar apenas um recurso ou uma matriz de vários capacidades

Política de devolução

  • resultado $ misto

    O ID do marcador (int) ou um WP_Error instância.

Exemplo 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');
}
de volta ao topo


parâmetros

Parâmetros disponíveis para o marcador de tipo

Parâmetro Requeridos? Tipo de dados Valor padrão Notas
idrequeridosnúmero inteirodefinido automaticamente ao adicionar um novo marcador
nome de marcaopcionalcordaNULL
geocódigoopcionalcordaNULL o valor é codificado geograficamente pela API do Google Places e substitui o parâmetro lat, lon e address
mapa base opcional IDs de mapa base predefinidos - ver notas mapa base padrão para o novo marcador (consulte as configurações) osm_mapnik, mapquest_osm, mapquest_aerial, googleLayer_roadmap, googleLayer_satellite, googleLayer_hybrid, googleLayer_terrain, bingaerial, bingaerialwithlabels, broadroad, ogdwien_basemap, ogdwien_satellite, mapbox, mapbox2, mapbox3, mapbox2, mapbox3,
camada opcional número inteiro camada padrão para o novo marcador (consulte as configurações)
latopcionalflutuarlocal padrão para o novo marcador (consulte as configurações) será sobrescrito se o geocódigo do parâmetro for usado!
lonopcionalflutuarlocal padrão para o novo marcador (consulte as configurações) será sobrescrito se o geocódigo do parâmetro for usado!
íconeopcionalstring (por exemplo, bus.png)NULL se NULL, o ícone padrão será usado. Por favor, basta usar o nome do arquivo do ícone, como indicado no exemplo. Todos os ícones disponíveis no diretório de ícones (normalmente / wp-content / uploads / leaflet-maps-marker-icons se você não o tiver alterado em Configurações / padrões do mapa / Valores padrão para ícones de marcadores) estão disponíveis para uso.
texto popupopcionalcordaNULL
zoomopcionalnúmero inteirozoom padrão para o novo marcador (consulte as configurações)
openpopupopcionalbooleanovalor padrão para novos marcadores (consulte as configurações)
largura do mapaopcionalnúmero inteirolargura de mapa padrão para novos marcadores (consulte as configurações)
mapwidthunitopcionalcordavalor padrão para novos marcadores (consulte as configurações)
altura do mapaopcionalnúmero inteiroaltura do mapa padrão para novos marcadores (consulte as configurações)
painelopcionalbooleanovalor padrão para novos marcadores (consulte as configurações)
criado poropcionalcordaNULL
criado emopcionaldata (H Hm: i: s)NULL
atualizado poropcionalcordaNULL
atualizado emopcionaldata (H Hm: i: s)data ('H: i: s)
caixa de controleopcionalbooleanovalor padrão para novos marcadores (consulte as configurações)
overlays_customopcionalbooleanovalor padrão para novos marcadores (consulte as configurações)
overlays_custom2opcionalbooleanovalor padrão para novos marcadores (consulte as configurações)
overlays_custom3opcionalbooleanovalor padrão para novos marcadores (consulte as configurações)
overlays_custom4opcionalbooleanovalor padrão para novos marcadores (consulte as configurações)
wmsopcionalbooleanovalor padrão para novos marcadores (consulte as configurações)
wms2opcionalbooleanovalor padrão para novos marcadores (consulte as configurações)
wms3opcionalbooleanovalor padrão para novos marcadores (consulte as configurações)
wms4opcionalbooleanovalor padrão para novos marcadores (consulte as configurações)
wms5opcionalbooleanovalor padrão para novos marcadores (consulte as configurações)
wms6opcionalbooleanovalor padrão para novos marcadores (consulte as configurações)
wms7opcionalbooleanovalor padrão para novos marcadores (consulte as configurações)
wms8opcionalbooleanovalor padrão para novos marcadores (consulte as configurações)
wms9opcionalbooleanovalor padrão para novos marcadores (consulte as configurações)
wms10opcionalbooleanovalor padrão para novos marcadores (consulte as configurações)
kml_timestampopcionaldata (H Hm: i: s)NULL
endereçoopcionalcordaNULL será sobrescrito se o geocódigo do parâmetro for usado!
gpx_urlopcionalcordaNULL desde a v1.2p
gpx_panelopcionalbooleano0 desde a v1.2p

de volta ao topo


Parâmetros disponíveis para a camada de tipos

Parâmetro Requeridos? Tipo de dados Valor padrão Notas
idrequeridosnúmero inteirodefinido automaticamente ao adicionar um novo marcador
geocódigoopcionalcordaNULL o valor é codificado geograficamente pela API do Google Places e substitui o parâmetro lat, lon e address
nomeopcionalcordaNULL
mapa baseopcionalvalores predefinidosmapa base padrão para nova camada (consulte as configurações) osm_mapnik, mapquest_osm, mapquest_aerial, googleLayer_roadmap, googleLayer_satellite, googleLayer_hybrid, googleLayer_terrain, bingaerial, bingaerialwithlabels, broadroad, ogdwien_basemap, ogdwien_satellite, mapbox, mapbox2, mapbox3, mapbox2, mapbox3,
layerzoomopcionalnúmero inteirozoom padrão para nova camada (consulte as configurações)
mapwidthunitopcionalcordavalor padrão para a nova camada (consulte as configurações)
largura do mapaopcionalnúmero inteirolargura de mapa padrão para a nova camada (consulte as configurações)
altura do mapaopcionalnúmero inteiroaltura do mapa padrão para a nova camada (consulte as configurações)
painelopcionalbooleanovalor padrão para a nova camada (consulte as configurações)
layerviewlatopcionalflutuarlat padrão para a nova camada (consulte as configurações) será sobrescrito se o geocódigo do parâmetro for usado!
layerviewlonopcionalflutuarlon padrão para a nova camada (consulte as configurações) será sobrescrito se o geocódigo do parâmetro for usado!
criado poropcionalcordaNULL
criado emopcionaldata (H Hm: i: s)NULL
atualizado poropcionalcordaNULL
atualizado emopcionaldata (H Hm: i: s)data ('H: i: s)
caixa de controleopcionalbooleanovalor padrão para a nova camada (consulte as configurações)
overlays_customrequeridosbooleanovalor padrão para a nova camada (consulte as configurações)
overlays_custom2requeridosbooleanovalor padrão para a nova camada (consulte as configurações)
overlays_custom3requeridosbooleanovalor padrão para a nova camada (consulte as configurações)
overlays_custom4requeridosbooleanovalor padrão para a nova camada (consulte as configurações)
wmsrequeridosbooleanovalor padrão para a nova camada (consulte as configurações)
wms2requeridosbooleanovalor padrão para a nova camada (consulte as configurações)
wms3requeridosbooleanovalor padrão para a nova camada (consulte as configurações)
wms4requeridosbooleanovalor padrão para a nova camada (consulte as configurações)
wms5requeridosbooleanovalor padrão para a nova camada (consulte as configurações)
wms6requeridosbooleanovalor padrão para a nova camada (consulte as configurações)
wms7requeridosbooleanovalor padrão para a nova camada (consulte as configurações)
wms8requeridosbooleanovalor padrão para a nova camada (consulte as configurações)
wms9requeridosbooleanovalor padrão para a nova camada (consulte as configurações)
wms10requeridosbooleanovalor padrão para a nova camada (consulte as configurações)
marcadores de listaopcionalbooleanovalor padrão para a nova camada (consulte as configurações) opção para mostrar a lista de marcadores abaixo dos mapas de camada
multi_layer_mapopcionalbooleano0
multi_layer_map_listopcionalstring (IDs de camada separados por vírgula ou todos)NULL por exemplo, 1,2,3,4 ou todos
endereçoopcionalcordaNULL será sobrescrito se o geocódigo do parâmetro for usado!
delete_markersopcionalverdadeiro falsofalso quando usado na ação de exclusão, também os marcadores atribuídos são excluídos
agrupamentoopcionalbooleanovalor padrão para a nova camada (consulte as configurações) disponível apenas na versão pro
gpx_urlopcionalcordaNULL desde a v1.2p
gpx_panelopcionalbooleano0 desde a v1.2p


Parâmetros especiais para ação da lista de marcadores

ParâmetroRequeridos?Tipo de dadosNotas
chave de ordemopcionalcordaValores da ordem de classificação permitidos: id, createdon, updatedon, kml_timestamp, nome da marca, mapa base, lat, lon, createdby, updatedby, address
ordenaropcionalcordaValores de direção de classificação permitidos: ASC, DESC
encomendaopcionalnúmero inteiroDeslocamento para a lista de marcadores
limite de pedidoopcionalnúmero inteiroLimite para a lista de marcadores
de volta ao topo


Parâmetros especiais para ação da lista de camadas

ParâmetroRequeridos?Tipo de dadosNotas
chave de ordemopcionalcordaValores permitidos da ordem de classificação: id, updatedon, createdon, name, basemap, layerviewlat, layerviewlon, createdby, updatedby, address
ordenaropcionalcordaValores de direção de classificação permitidos: ASC, DESC
encomendaopcionalnúmero inteiroDeslocamento para a lista de camadas
limite de pedidoopcionalnúmero inteiroLimite para a lista de camadas
de volta ao topo


Parâmetros especiais para ação de pesquisa

ParâmetroRequeridos?Tipo de dadosNotas
chave de pesquisarequeridoscordaTeclas de pesquisa permitidas: id, nome da marca, mapa base, camada, lat, lon, ícone, texto pop-up, zoom, pop-up aberto, largura do mapa, unidade de largura do mapa, altura do mapa, painel, criado por, criado em, atualizado por, atualizado em, caixa de controle, personalizado sobreposição, sobreposição_custom2, sobreposição_custom3, sobreposição_custom4, wms , wms2, wms3, wms4, wms5, wms6, wms7, wms8, wms9, kml_timestamp, endereço, gpx_url, gpx_panel, nome, layerzoom, layerviewlat, layerviewlon, listmarkers, multi_layer_map, multi_layer_map_box_list,
searchvaluedependesequência ou número inteirogeralmente necessário, mas opcional ao usar a tecla de pesquisa criada, atualizada ou caixa delimitadora
data_dedependesequência (Ymd H: i: s)geralmente opcional, mas necessário ao usar a chave de pesquisa criada ou atualizada
data paradependesequência (Ymd H: i: s)geralmente opcional, mas necessário ao usar a chave de pesquisa criada ou atualizada
lat_top_leftdependefloatval (6)geralmente opcional, mas necessário ao usar a caixa de ligação da chave de pesquisa
lon_top_leftdependefloatval (6)geralmente opcional, mas necessário ao usar a caixa de ligação da chave de pesquisa
lat_bottom_rightdependefloatval (6)geralmente opcional, mas necessário ao usar a caixa de ligação da chave de pesquisa
lon_bottom_rightdependefloatval (6)geralmente opcional, mas necessário ao usar a caixa de ligação da chave de pesquisa
de volta ao topo