Uwaga: MMPAPI został usunięty z wersją 4.0, wymiana: Baza danych API

Dokumentacja MMPAPI

powrót do przeglądu API

Funkcje MMPAPI

  1. Wprowadzenie
  2. wygenerowany opis klasy
  3. markery
    1. Dodaj znacznik
    2. dodaj znaczniki
    3. markery_liczników
    4. delete_marker
    5. delete_markers
    6. get_marker
    7. get_markers
    8. znaczniki list
    9. znaczniki wyszukiwania
    10. update_marker
    11. update_markers
  4. Warstwy
    1. add_layer
    2. add_layers
    3. liczba graczy
    4. delete_layer
    5. delete_layers
    6. get_layer
    7. get_layers
    8. list_layers
    9. wyszukiwarki
    10. update_layer
    11. update_layers
  5. Uprawnienia
    1. aktualny_użytkownik_kanału
  6. parametry
    1. Dostępne parametry znacznika typu
    2. Dostępne parametry dla warstwy tekstowej
    3. Parametry specjalne dla akcji na liście znaczników
    4. Specjalne parametry dla akcji listy warstw
    5. Specjalne parametry dla akcji wyszukiwania


Wprowadzenie

Funkcje API Maps Marker Pro zapewniają programistom przyszłościowy sposób dostępu do niektórych popularnych podstawowych funkcji Maps Marker Pro.

Funkcje API są automatycznie uwzględniane po załadowaniu Maps Marker Pro i będą dostępne do czasu załadowania dodatków. Klasa API nazywa się MMPAPI i można ją znaleźć w /leaflet-maps-marker-pro/inc/class-mmpapi.php.


Wygenerowany opis klasy

Automatycznie wygenerowany opis klasy można znaleźć na stronie https://www.mapsmarker.com/wp-content/uploads/mmpapi/class/


markery

Dodaj znacznik

Dodaje nowy znacznik za pomocą podanego obiektu Marker. Ostrzeżenie, mało sprawdzane jest, aby upewnić się, że jest to prawidłowy obiekt Marker.

public static function add_marker( $marker_data ) {}

parametry

Powroty

Przykład użycia


$marker_data = array(
	'markername' => 'Headquarter',
	'geocode' => 'Main Street 1 Washington',
);
$marker_id = MMPAPI::add_marker( $marker_data );
powrót do góry


dodaj znaczniki

Dodaj znaczniki na podstawie danych obiektów danych.

public static function add_markers( $markers_data ) {}

parametry

Powroty

  • Markery $ mieszany

    Tablica identyfikatorów znaczników lub obiekt WP_Error.

Przykład użycia


$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 );
powrót do góry


markery_liczników

Zwraca liczbę dostępnych znaczników.

public static function count_markers( ) {}

Powroty

  • $ markers_count int

    Liczniki się liczą

Przykład użycia

$result = MMPAPI::count_markers( );
powrót do góry


delete_marker

Usuwa znacznik o podanym identyfikatorze znacznika.

public static function delete_marker( $marker_id ) {}

parametry

Powroty

Przykład użycia

$result = MMPAPI::delete_marker( $marker_id );
powrót do góry


delete_markers

Usuwa markery dla podanych identyfikatorów markerów

public static function delete_markers( $marker_ids ) {}

parametry

  • $ marker_ids szyk

    Identyfikatory markerów.

Powroty

  • wynik $ mieszany

    Prawda, jeśli znaczniki zostały pomyślnie usunięte, WP_Error sprzeciw, jeśli nie.

Przykład użycia


$marker_ids = array(6,7,8);
$result = MMPAPI::delete_markers( $marker_ids );
powrót do góry


get_marker

Zwraca obiekt znacznika dla danego identyfikatora znacznika.

public static function get_marker( $marker_id ) {}

parametry

Powroty

  • wynik $ mieszany

    Obiekt znacznika lub False.

Przykład użycia

$result = MMPAPI::get_marker( 5 );
powrót do góry


get_markers

Zwraca obiekty znaczników dla podanych identyfikatorów znaczników.

public static function get_markers( $marker_ids ) {}

parametry

  • $ marker_ids szyk

    Identyfikatory markerów.

Powroty

  • wynik $ mieszany

    Znacznik obiektów lub False.

Przykład użycia

$result = MMPAPI::get_markers( array( 1, 5, 10 ) );
powrót do góry


znaczniki list

Zwraca wszystkie obiekty znaczników.

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

parametry

Powroty

  • wynik $ mieszany

    Znacznik obiektów lub False.

Przykład użycia


$args['orderkey'] = 'markername';
$args['orderdir'] = 'ASC';
$result = MMPAPI::list_markers( $args );
powrót do góry


znaczniki wyszukiwania

Wyszukaj obiekt znaczników dla podanych argumentów.

public static function search_markers( $args ) {}

parametry

Powroty

  • wynik $ mieszany

    Obiekty znaczników pasujące do parametrów lub False.

Przykład użycia


$args['searchkey'] = 'layer';
$args['searchvalue'] = 7;
$result = MMPAPI::search_markers( $args );
powrót do góry


update_marker

Aktualizuje znacznik na podstawie podanego obiektu danych

public static function update_marker( $marker_data ) {}

parametry

Powroty

  • wynik $ boolean

    Prawda, jeśli znacznik został zaktualizowany, fałsz w przeciwnym razie.

Przykład użycia


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

$result = MMPAPI::update_marker( $marker_data );
powrót do góry


update_markers

Zaktualizuj markery w oparciu o dany obiekt danych

public static function update_markers( $markers_data ) {}

parametry

Powroty

  • wynik $ mieszany

    Tablica identyfikatorów zaktualizowanych znaczników lub obiekt błędu.

Przykład użycia


$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 );
powrót do góry


Warstwy

add_layer

Dodaje nową warstwę za pomocą podanego obiektu Layer. Ostrzeżenie, mało sprawdzane jest, aby upewnić się, że jest to prawidłowy obiekt warstwy.

public static function add_layer( $layer_data ) {}

parametry

Powroty

Przykład użycia


$layer_data = array(
	'name' => 'Headquarter',
	'geocode' => 'Main Street 1 Washington',
);
$layer_id = MMPAPI::add_layer( $layer_data );
powrót do góry


add_layers

Dodaj warstwy na podstawie podanych obiektów danych.

public static function add_layers( $layers_data ) {}

parametry

Powroty

  • warstwy $ mieszany

    Tablica identyfikatorów warstw lub obiekt WP_Error.

Przykład użycia


$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 );
powrót do góry


liczba graczy

Zwraca liczbę dostępnych warstw.

public static function count_layers( ) {}

Powroty

  • $ layer_count int

    Warstwy się liczą

Przykład użycia

$result = MMPAPI::count_layers( );
powrót do góry


delete_layer

Usuwa warstwę o podanym identyfikatorze warstwy.

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

parametry

  • $ layer_id liczba całkowita

    Identyfikator warstwy do usunięcia.

  • $ delete_markers boolean

    Parametr boolowski, jeśli ustawiono na PRAWDA, metoda usunie wszystkie znaczniki związane z warstwą. Wartość domyślna to FAŁSZ.

Powroty

Przykład użycia

$result = MMPAPI::delete_layer( $layer_id );
powrót do góry


delete_layers

Usuwa warstwy dla podanych identyfikatorów warstw

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

parametry

  • $ layer_ids szyk

    Identyfikatory warstw.

  • $ delete_markers boolean

    Parametr boolowski, jeśli ustawiono na PRAWDA, metoda usunie wszystkie znaczniki związane z warstwami. Wartość domyślna to FAŁSZ.

Powroty

  • wynik $ mieszany

    Prawda, jeśli warstwy zostały pomyślnie usunięte, WP_Error sprzeciw, jeśli nie.

Przykład użycia


$layers_ids = array(6,7,8);
$result = MMPAPI::delete_layers( $layers_ids );
powrót do góry


get_layer

Zwraca obiekt warstwy dla danego identyfikatora warstwy.

public static function get_layer( $layer_id ) {}

parametry

Powroty

  • wynik $ mieszany

    Obiekt warstwy lub False.

Przykład użycia

$result = MMPAPI::get_layer( 5 );
powrót do góry


get_layers

Zwraca obiekty warstw dla podanych ID warstw.

public static function get_layers( $layer_ids ) {}

parametry

  • $ layer_ids szyk

    Identyfikatory warstw.

Powroty

  • wynik $ mieszany

    Obiekty warstwy lub False.

Przykład użycia

$result = MMPAPI::get_layers( array( 1, 5, 10 ) );
powrót do góry


list_layers

Zwraca wszystkie obiekty warstwy.

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

parametry

Powroty

  • wynik $ mieszany

    Obiekty warstwy lub False.

Przykład użycia


$args['orderkey'] = 'name';
$args['orderdir'] = 'ASC';
$result = MMPAPI::list_layers( $args );
powrót do góry


wyszukiwarki

Przeszukaj obiekt warstw dla podanych argumentów.

public static function search_layers( $args ) {}

parametry

Powroty

  • wynik $ mieszany

    Obiekty warstw pasujące do parametrów lub False.

Przykład użycia


$args['searchkey'] = 'name';
$args['searchvalue'] = 'Washington';
$result = MMPAPI::search_layers( $args );
powrót do góry


update_layer

Aktualizuje warstwę na podstawie podanego obiektu danych

public static function update_layer( $layer_data ) {}

parametry

Powroty

  • wynik $ boolean

    Prawda, jeśli warstwa została zaktualizowana, w przeciwnym razie fałsz.

Przykład użycia


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

$result = MMPAPI::update_layer( $layer_data );
powrót do góry


update_layers

Zaktualizuj warstwy w oparciu o dany obiekt danych

public static function update_layers( $layers_data ) {}

parametry

Powroty

  • wynik $ mieszany

    Tablica identyfikatorów zaktualizowanych warstw lub obiekt błędu.

Przykład użycia


// 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 );
powrót do góry

Uprawnienia

aktualny_użytkownik_kanału

Sprawdza uprawnienia dla bieżącego użytkownika. Zwraca wartość true, jeśli bieżący użytkownik ma którąkolwiek z określonych możliwości.

WAŻNE: wywołaj to przed wywołaniem dowolnej innej funkcji API, ponieważ kontrole uprawnień nie są wykonywane na niższych poziomach.

public static function current_user_can_any( $capabilities ) {}

parametry

  • możliwości $ mieszany

    Ciąg, jeśli chcesz sprawdzić tylko jedną możliwość lub tablicę wielu możliwości

Powroty

Przykład użycia


$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');
}
powrót do góry


parametry

Dostępne parametry znacznika typu

Parametr Wymagany? Typ danych Domyślna wartość Uwagi
idwymaganyliczba całkowitaustawiane automatycznie po dodaniu nowego znacznika
nazwa markifakultatywnyciągNULL
geokodfakultatywnyciągNULL wartość jest geokodowana za pomocą interfejsu API Miejsc Google i zastępuje parametr lat, lon i adres
Mapa bazy fakultatywny predefiniowane identyfikatory mapy bazowej - patrz uwagi domyślna mapa bazowa dla nowego znacznika (patrz ustawienia) osm_mapnik, mapquest_osm, mapquest_aerial, googleLayer_roadmap, googleLayer_satellite, googleLayer_hybrid, googleLayer_terrain, bingaerial, bingaerialwithlabels, bingroad, ogdwien_basemap, custom__bapbox, custom__bapbox, custom__bap
warstwa fakultatywny liczba całkowita domyślna warstwa dla nowego znacznika (patrz ustawienia)
latfakultatywnyunosić siędomyślna lokalizacja nowego znacznika (patrz ustawienia) zostanie zastąpiony, jeśli użyty zostanie parametr geokod!
lonfakultatywnyunosić siędomyślna lokalizacja nowego znacznika (patrz ustawienia) zostanie zastąpiony, jeśli użyty zostanie parametr geokod!
ikonafakultatywnyciąg (np. bus.png)NULL jeśli NULL, zostanie użyta domyślna ikona. Proszę po prostu użyć nazwy pliku ikony podanej w przykładzie. Wszystkie ikony dostępne w katalogu ikon (zwykle / wp-content / uploads / leaflet-maps-marker-icons, jeśli nie zmieniłeś ich w Ustawieniach / domyślnych mapach / Domyślne wartości ikon znaczników) są dostępne do użycia.
wyskakujący tekstfakultatywnyciągNULL
zoomfakultatywnyliczba całkowitadomyślne powiększenie nowego znacznika (patrz ustawienia)
openpopupfakultatywnybooleanwartość domyślna dla nowych znaczników (patrz ustawienia)
szerokość mapyfakultatywnyliczba całkowitadomyślna szerokość mapy dla nowych znaczników (patrz ustawienia)
mapwidthunitfakultatywnyciągwartość domyślna dla nowych znaczników (patrz ustawienia)
wysokość mapyfakultatywnyliczba całkowitadomyślna wysokość mapy dla nowych znaczników (patrz ustawienia)
płytafakultatywnybooleanwartość domyślna dla nowych znaczników (patrz ustawienia)
stworzone przezfakultatywnyciągNULL
utworzonyfakultatywnydata (Ymd H: i: s)NULL
aktualizowany przezfakultatywnyciągNULL
zaktualizowanofakultatywnydata (Ymd H: i: s)data („Ymd H: i: s)
skrzynka kontrolnafakultatywnybooleanwartość domyślna dla nowych znaczników (patrz ustawienia)
overlays_customfakultatywnybooleanwartość domyślna dla nowych znaczników (patrz ustawienia)
overlays_custom2fakultatywnybooleanwartość domyślna dla nowych znaczników (patrz ustawienia)
overlays_custom3fakultatywnybooleanwartość domyślna dla nowych znaczników (patrz ustawienia)
overlays_custom4fakultatywnybooleanwartość domyślna dla nowych znaczników (patrz ustawienia)
WMSfakultatywnybooleanwartość domyślna dla nowych znaczników (patrz ustawienia)
wms2fakultatywnybooleanwartość domyślna dla nowych znaczników (patrz ustawienia)
wms3fakultatywnybooleanwartość domyślna dla nowych znaczników (patrz ustawienia)
wms4fakultatywnybooleanwartość domyślna dla nowych znaczników (patrz ustawienia)
wms5fakultatywnybooleanwartość domyślna dla nowych znaczników (patrz ustawienia)
wms6fakultatywnybooleanwartość domyślna dla nowych znaczników (patrz ustawienia)
wms7fakultatywnybooleanwartość domyślna dla nowych znaczników (patrz ustawienia)
wms8fakultatywnybooleanwartość domyślna dla nowych znaczników (patrz ustawienia)
wms9fakultatywnybooleanwartość domyślna dla nowych znaczników (patrz ustawienia)
wms10fakultatywnybooleanwartość domyślna dla nowych znaczników (patrz ustawienia)
kml_timestampfakultatywnydata (Ymd H: i: s)NULL
adresfakultatywnyciągNULL zostanie zastąpiony, jeśli użyty zostanie parametr geokod!
gpx_urlfakultatywnyciągNULL od wersji 1.2p
gpx_panelfakultatywnyboolean0 od wersji 1.2p

powrót do góry


Dostępne parametry dla warstwy tekstowej

Parametr Wymagany? Typ danych Domyślna wartość Uwagi
idwymaganyliczba całkowitaustawiane automatycznie po dodaniu nowego znacznika
geokodfakultatywnyciągNULL wartość jest geokodowana za pomocą interfejsu API Miejsc Google i zastępuje parametr lat, lon i adres
NazwafakultatywnyciągNULL
Mapa bazyfakultatywnypredefiniowane wartościdomyślna mapa bazowa dla nowej warstwy (patrz ustawienia) osm_mapnik, mapquest_osm, mapquest_aerial, googleLayer_roadmap, googleLayer_satellite, googleLayer_hybrid, googleLayer_terrain, bingaerial, bingaerialwithlabels, bingroad, ogdwien_basemap, custom__bapbox, custom__bapbox, custom__bap
layerzoomfakultatywnyliczba całkowitadomyślne powiększenie nowej warstwy (patrz ustawienia)
mapwidthunitfakultatywnyciągwartość domyślna dla nowej warstwy (patrz ustawienia)
szerokość mapyfakultatywnyliczba całkowitadomyślna szerokość mapy dla nowej warstwy (patrz ustawienia)
wysokość mapyfakultatywnyliczba całkowitadomyślna wysokość mapy dla nowej warstwy (patrz ustawienia)
płytafakultatywnybooleanwartość domyślna dla nowej warstwy (patrz ustawienia)
layerviewlatfakultatywnyunosić siędomyślna łata dla nowej warstwy (patrz ustawienia) zostanie zastąpiony, jeśli użyty zostanie parametr geokod!
layerviewlonfakultatywnyunosić siędomyślny lon dla nowej warstwy (patrz ustawienia) zostanie zastąpiony, jeśli użyty zostanie parametr geokod!
stworzone przezfakultatywnyciągNULL
utworzonyfakultatywnydata (Ymd H: i: s)NULL
aktualizowany przezfakultatywnyciągNULL
zaktualizowanofakultatywnydata (Ymd H: i: s)data („Ymd H: i: s)
skrzynka kontrolnafakultatywnybooleanwartość domyślna dla nowej warstwy (patrz ustawienia)
overlays_customwymaganybooleanwartość domyślna dla nowej warstwy (patrz ustawienia)
overlays_custom2wymaganybooleanwartość domyślna dla nowej warstwy (patrz ustawienia)
overlays_custom3wymaganybooleanwartość domyślna dla nowej warstwy (patrz ustawienia)
overlays_custom4wymaganybooleanwartość domyślna dla nowej warstwy (patrz ustawienia)
WMSwymaganybooleanwartość domyślna dla nowej warstwy (patrz ustawienia)
wms2wymaganybooleanwartość domyślna dla nowej warstwy (patrz ustawienia)
wms3wymaganybooleanwartość domyślna dla nowej warstwy (patrz ustawienia)
wms4wymaganybooleanwartość domyślna dla nowej warstwy (patrz ustawienia)
wms5wymaganybooleanwartość domyślna dla nowej warstwy (patrz ustawienia)
wms6wymaganybooleanwartość domyślna dla nowej warstwy (patrz ustawienia)
wms7wymaganybooleanwartość domyślna dla nowej warstwy (patrz ustawienia)
wms8wymaganybooleanwartość domyślna dla nowej warstwy (patrz ustawienia)
wms9wymaganybooleanwartość domyślna dla nowej warstwy (patrz ustawienia)
wms10wymaganybooleanwartość domyślna dla nowej warstwy (patrz ustawienia)
znaczniki listfakultatywnybooleanwartość domyślna dla nowej warstwy (patrz ustawienia) opcja pokazania listy markerów pod mapami warstw
multi_layer_mapfakultatywnyboolean0
multi_layer_map_listfakultatywnyciąg (identyfikatory warstw oddzielone przecinkami lub wszystkie)NULL np. 1,2,3,4 lub wszystkie
adresfakultatywnyciągNULL zostanie zastąpiony, jeśli użyty zostanie parametr geokod!
delete_markersfakultatywnyprawda fałszfałszywy w przypadku użycia w akcji usuwania usuwane są również przypisane znaczniki
klastrowaniefakultatywnybooleanwartość domyślna dla nowej warstwy (patrz ustawienia) dostępne tylko w wersji pro
gpx_urlfakultatywnyciągNULL od wersji 1.2p
gpx_panelfakultatywnyboolean0 od wersji 1.2p


Parametry specjalne dla akcji na liście znaczników

ParametrWymagany?Typ danychUwagi
klucz zamówieniafakultatywnyciągDozwolone wartości kolejności sortowania: id, Createdon, updatedon, kml_timestamp, markername, basemap, lat, lon, Createdby, updatedby, address
orderdirfakultatywnyciągDozwolone wartości kierunku sortowania: ASC, DESC
zamówieniefakultatywnyliczba całkowitaPrzesunięcie listy znaczników
orderlimitfakultatywnyliczba całkowitaLimit dla listy znaczników
powrót do góry


Specjalne parametry dla akcji listy warstw

ParametrWymagany?Typ danychUwagi
klucz zamówieniafakultatywnyciągDozwolone wartości kolejności sortowania: id, updatedon, Createdon, name, basemap, layerviewlat, layerviewlon, utworzone przez, zaktualizowane przez, adres
orderdirfakultatywnyciągDozwolone wartości kierunku sortowania: ASC, DESC
zamówieniefakultatywnyliczba całkowitaPrzesunięcie listy warstw
orderlimitfakultatywnyliczba całkowitaLimit dla listy warstw
powrót do góry


Specjalne parametry dla akcji wyszukiwania

ParametrWymagany?Typ danychUwagi
klucz wyszukiwaniawymaganyciągDozwolone klawisze wyszukiwania: id, nazwa markera, mapa bazowa, warstwa, lat, lon, ikona, popup, tekst, powiększenie, openpopup, szerokość mapy, mapwidthunit, wysokość mapy, panel, utworzone przez, utworzone przez, zaktualizowane, zaktualizowane, skrzynka kontrolna, nakładki_standardowe, nakładki_standardowe2, nakładki niestandardowe3, nakładki_standardowe4, wms , wms2, wms3, wms4, wms5, wms6, wms7, wms8, wms9, wms10, kml_timestamp, adres, gpx_url, gpx_panel, nazwa, layerzoom, layerviewlat, layerviewlon, markery, mult_layer_map, multi_layer_map_list
wartość wyszukiwaniazależyciąg lub liczba całkowitageneralnie wymagane, ale opcjonalne w przypadku użycia klucza wyszukiwania utworzonego na, zaktualizowanym lub obwiedni
Data, odzależyciąg (Ymd H: i: s)generalnie opcjonalne, ale wymagane w przypadku używania klucza wyszukiwania utworzonego lub zaktualizowanego
data_dozależyciąg (Ymd H: i: s)generalnie opcjonalne, ale wymagane w przypadku używania klucza wyszukiwania utworzonego lub zaktualizowanego
lat_top_leftzależyfloatval (6)generalnie opcjonalne, ale wymagane w przypadku korzystania z pola granicznego wyszukiwania
lon_top_leftzależyfloatval (6)generalnie opcjonalne, ale wymagane w przypadku korzystania z pola granicznego wyszukiwania
lat_bottom_rightzależyfloatval (6)generalnie opcjonalne, ale wymagane w przypadku korzystania z pola granicznego wyszukiwania
lon_bottom_rightzależyfloatval (6)generalnie opcjonalne, ale wymagane w przypadku korzystania z pola granicznego wyszukiwania
powrót do góry