Achtung: Das MMPAPI wurde mit v4.0 entfernt, Ersatz: Datenbank-API

MMPAPI-Dokumentation

zurück zur API-Übersicht

MMPAPI-Funktionen

  1. Einführung
  2. generierte Klassenbeschreibung
  3. Marker
    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. Schichten
    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. Berechtigungen
    1. current_user_can_any
  6. Parameter
    1. Verfügbare Parameter für die Typmarkierung
    2. Verfügbare Parameter für die Textebene
    3. Spezielle Parameter für die Aktion der Markierungsliste
    4. Spezielle Parameter für die Ebenenlistenaktion
    5. Spezielle Parameter für Suchaktionen


Einführung

Die Maps Marker Pro-API-Funktionen bieten Entwicklern eine zukunftssichere Möglichkeit, auf einige der allgemeinen Kernfunktionen von Maps Marker Pro zuzugreifen.

Die API-Funktionen werden beim Laden von Maps Marker Pro automatisch einbezogen und sind verfügbar, wenn Add-Ons geladen werden. Die API-Klasse heißt MMPAPI und befindet sich in /leaflet-maps-marker-pro/inc/class-mmpapi.php.


Generierte Klassenbeschreibung

Die automatisch generierte Klassenbeschreibung finden Sie unter https://www.mapsmarker.com/wp-content/uploads/mmpapi/class/


Marker

add_marker

Fügt mit dem angegebenen Marker-Objekt einen neuen Marker hinzu. Achtung, es wird wenig überprüft, um sicherzustellen, dass es sich um ein gültiges Marker-Objekt handelt.

public static function add_marker( $marker_data ) {}

Parameter

RETOUREN

Anwendungsbeispiel


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


add_markers

Fügen Sie Markierungen basierend auf bestimmten Datenobjekten hinzu.

public static function add_markers( $markers_data ) {}

Parameter

RETOUREN

  • $ Marker gemischt

    Ein Array von Marker-IDs oder ein WP_Error-Objekt.

Anwendungsbeispiel


$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 );
nach oben


count_markers

Gibt die Anzahl der verfügbaren Marker zurück.

public static function count_markers( ) {}

RETOUREN

  • $ marker_count int

    Die Marker zählen

Anwendungsbeispiel

$result = MMPAPI::count_markers( );
nach oben


delete_marker

Löscht den Marker mit der angegebenen Marker-ID.

public static function delete_marker( $marker_id ) {}

Parameter

  • $ marker_id ganze Zahl

    Die ID des zu löschenden Markers.

RETOUREN

Anwendungsbeispiel

$result = MMPAPI::delete_marker( $marker_id );
nach oben


delete_markers

Löscht die Markierungen für eine bestimmte Markierungs-ID

public static function delete_markers( $marker_ids ) {}

Parameter

  • $ marker_ids Feld

    Die IDs der Marker.

RETOUREN

  • $ result gemischt

    True, wenn die Marker erfolgreich gelöscht wurden, WP_Error Objekt, wenn nicht.

Anwendungsbeispiel


$marker_ids = array(6,7,8);
$result = MMPAPI::delete_markers( $marker_ids );
nach oben


get_marker

Gibt das Markerobjekt für eine bestimmte Marker-ID zurück.

public static function get_marker( $marker_id ) {}

Parameter

RETOUREN

  • $ result gemischt

    Das Markierungsobjekt oder Falsch.

Anwendungsbeispiel

$result = MMPAPI::get_marker( 5 );
nach oben


get_markers

Gibt die Markerobjekte für die angegebenen Marker-IDs zurück.

public static function get_markers( $marker_ids ) {}

Parameter

  • $ marker_ids Feld

    Die IDs der Marker.

RETOUREN

  • $ result gemischt

    Die Markerobjekte oder False.

Anwendungsbeispiel

$result = MMPAPI::get_markers( array( 1, 5, 10 ) );
nach oben


list_markers

Gibt alle Markierungsobjekte zurück.

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

Parameter

RETOUREN

  • $ result gemischt

    Die Markerobjekte oder False.

Anwendungsbeispiel


$args['orderkey'] = 'markername';
$args['orderdir'] = 'ASC';
$result = MMPAPI::list_markers( $args );
nach oben


search_markers

Suchmarkierungsobjekt für ein bestimmtes Argument.

public static function search_markers( $args ) {}

Parameter

RETOUREN

  • $ result gemischt

    Die Markierungsobjekte, die den Parametern entsprechen, oder False.

Anwendungsbeispiel


$args['searchkey'] = 'layer';
$args['searchvalue'] = 7;
$result = MMPAPI::search_markers( $args );
nach oben


update_marker

Aktualisiert eine Markierung basierend auf einem bestimmten Datenobjekt

public static function update_marker( $marker_data ) {}

Parameter

RETOUREN

  • $ result boolean

    True, wenn der Marker aktualisiert wurde, andernfalls false.

Anwendungsbeispiel


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

$result = MMPAPI::update_marker( $marker_data );
nach oben


update_markers

Aktualisieren Sie die Markierungen basierend auf dem angegebenen Datenobjekt

public static function update_markers( $markers_data ) {}

Parameter

RETOUREN

  • $ result gemischt

    Array von IDs aktualisierter Marker oder eines Fehlerobjekts.

Anwendungsbeispiel


$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 );
nach oben


Schichten

add_layer

Fügt eine neue Ebene mit dem angegebenen Ebenenobjekt hinzu. Achtung, es wird wenig überprüft, um sicherzustellen, dass es sich um ein gültiges Layer-Objekt handelt.

public static function add_layer( $layer_data ) {}

Parameter

RETOUREN

Anwendungsbeispiel


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


add_layers

Fügen Sie Ebenen basierend auf bestimmten Datenobjekten hinzu.

public static function add_layers( $layers_data ) {}

Parameter

RETOUREN

  • $ Schichten gemischt

    Ein Array von Layer-IDs oder ein WP_Error-Objekt.

Anwendungsbeispiel


$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 );
nach oben


count_layers

Gibt die Anzahl der verfügbaren Ebenen zurück.

public static function count_layers( ) {}

RETOUREN

  • $ layer_count int

    Die Schichten zählen

Anwendungsbeispiel

$result = MMPAPI::count_layers( );
nach oben


delete_layer

Löscht die Ebene mit der angegebenen Ebenen-ID.

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

Parameter

  • $ layer_id ganze Zahl

    Die ID der zu löschenden Ebene.

  • $ delete_markers boolean

    Ein boolescher Parameter, wenn er auf TRUE gesetzt wurde, löscht die Methode alle Markierungen, die der Ebene zugeordnet sind. Der Standardwert ist FALSE.

RETOUREN

Anwendungsbeispiel

$result = MMPAPI::delete_layer( $layer_id );
nach oben


delete_layers

Löscht die Ebenen für eine bestimmte Ebenen-ID

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

Parameter

  • $ layer_ids Feld

    Die IDs der Ebenen.

  • $ delete_markers boolean

    Ein boolescher Parameter, wenn er auf TRUE gesetzt wurde, löscht die Methode alle Markierungen, die den Ebenen zugeordnet sind. Der Standardwert ist FALSE.

RETOUREN

  • $ result gemischt

    True, wenn die Ebenen erfolgreich gelöscht wurden, WP_Error Objekt, wenn nicht.

Anwendungsbeispiel


$layers_ids = array(6,7,8);
$result = MMPAPI::delete_layers( $layers_ids );
nach oben


get_layer

Gibt das Ebenenobjekt für eine bestimmte Ebenen-ID zurück.

public static function get_layer( $layer_id ) {}

Parameter

RETOUREN

  • $ result gemischt

    Das Ebenenobjekt oder Falsch.

Anwendungsbeispiel

$result = MMPAPI::get_layer( 5 );
nach oben


get_layers

Gibt die Layerobjekte für bestimmte Layer-IDs zurück.

public static function get_layers( $layer_ids ) {}

Parameter

  • $ layer_ids Feld

    Die IDs der Ebenen.

RETOUREN

  • $ result gemischt

    Die Ebenenobjekte oder Falsch.

Anwendungsbeispiel

$result = MMPAPI::get_layers( array( 1, 5, 10 ) );
nach oben


list_layers

Gibt alle Ebenenobjekte zurück.

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

Parameter

RETOUREN

  • $ result gemischt

    Die Ebenenobjekte oder Falsch.

Anwendungsbeispiel


$args['orderkey'] = 'name';
$args['orderdir'] = 'ASC';
$result = MMPAPI::list_layers( $args );
nach oben


search_layers

Suchebenenobjekt für ein bestimmtes Argument.

public static function search_layers( $args ) {}

Parameter

RETOUREN

  • $ result gemischt

    Die Layer-Objekte, die den Parametern entsprechen, oder False.

Anwendungsbeispiel


$args['searchkey'] = 'name';
$args['searchvalue'] = 'Washington';
$result = MMPAPI::search_layers( $args );
nach oben


update_layer

Aktualisiert eine Ebene basierend auf einem bestimmten Datenobjekt

public static function update_layer( $layer_data ) {}

Parameter

RETOUREN

  • $ result boolean

    True, wenn die Ebene aktualisiert wurde, andernfalls false.

Anwendungsbeispiel


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

$result = MMPAPI::update_layer( $layer_data );
nach oben


update_layers

Aktualisieren Sie Ebenen basierend auf dem angegebenen Datenobjekt

public static function update_layers( $layers_data ) {}

Parameter

RETOUREN

  • $ result gemischt

    Array von IDs aktualisierter Ebenen oder eines Fehlerobjekts.

Anwendungsbeispiel


// 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 );
nach oben

Berechtigungen

current_user_can_any

Überprüft die Berechtigungen für den aktuellen Benutzer. Gibt true zurück, wenn der aktuelle Benutzer über eine der angegebenen Funktionen verfügt.

WICHTIG: Rufen Sie dies auf, bevor Sie eine der anderen API-Funktionen aufrufen, da Berechtigungsprüfungen nicht auf niedrigeren Ebenen durchgeführt werden.

public static function current_user_can_any( $capabilities ) {}

Parameter

  • $ Fähigkeiten gemischt

    Zeichenfolge, wenn Sie nur eine Funktion oder ein Array von mehreren überprüfen möchten Fähigkeiten

RETOUREN

Anwendungsbeispiel


$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');
}
nach oben


Parameter

Verfügbare Parameter für die Typmarkierung

Parameter Erforderlich? Datentyp Standardwert Wichtige Informationen
iderforderlichganze ZahlWird beim Hinzufügen eines neuen Markers automatisch festgelegt
MarkennamefakultativSchnurNULL
GeocodefakultativSchnurNULL Der Wert wird über die Google Places-API geokodiert und überschreibt die Parameter lat, lon und address
Basiskarte fakultativ vordefinierte Grundkarten-IDs - siehe Hinweise Standard-Grundkarte für neuen Marker (siehe Einstellungen) osm_mapnik, mapquest_osm, mapquest_aerial, googleLayer_roadmap, googleLayer_satellite, googleLayer_hybrid, googleLayer_terrain, bingaerial, bingaerialwithlabels, bingroad, ogdwien_basemap, ogdwien_sapap_
Schicht fakultativ ganze Zahl Standardebene für neuen Marker (siehe Einstellungen)
latfakultativschwebenStandardposition für neue Markierung (siehe Einstellungen) wird überschrieben, wenn der Parameter Geocode verwendet wird!
lonfakultativschwebenStandardposition für neue Markierung (siehe Einstellungen) wird überschrieben, wenn der Parameter Geocode verwendet wird!
SymbolfakultativZeichenfolge (z. B. bus.png)NULL Wenn NULL, wird das Standardsymbol verwendet. Bitte verwenden Sie einfach den Dateinamen des Symbols, wie im Beispiel angegeben. Alle im Symbolverzeichnis verfügbaren Symbole (normalerweise / wp-content / uploads / leaflet-maps-marker-icons, wenn Sie sie nicht in Einstellungen / Kartenstandards / Standardwerte für Markierungssymbole geändert haben) können verwendet werden.
PopuptextfakultativSchnurNULL
Zoomfakultativganze ZahlStandardzoom für neue Markierung (siehe Einstellungen)
openpopupfakultativbooleanStandardwert für neue Marker (siehe Einstellungen)
Kartenbreitefakultativganze ZahlStandardzuordnungsbreite für neue Markierungen (siehe Einstellungen)
mapwidthunitfakultativSchnurStandardwert für neue Marker (siehe Einstellungen)
Kartenhöhefakultativganze ZahlStandardkartenhöhe für neue Markierungen (siehe Einstellungen)
TafelfakultativbooleanStandardwert für neue Marker (siehe Einstellungen)
erstellt vonfakultativSchnurNULL
erstellt amfakultativDatum (Ymd H: i: s)NULL
aktualisiert vonfakultativSchnurNULL
aktualisiert amfakultativDatum (Ymd H: i: s)Datum ('Ymd H: i: s)
KontrollkastenfakultativbooleanStandardwert für neue Marker (siehe Einstellungen)
Overlays_CustomfakultativbooleanStandardwert für neue Marker (siehe Einstellungen)
Overlays_Custom2fakultativbooleanStandardwert für neue Marker (siehe Einstellungen)
Overlays_Custom3fakultativbooleanStandardwert für neue Marker (siehe Einstellungen)
Overlays_Custom4fakultativbooleanStandardwert für neue Marker (siehe Einstellungen)
wmsfakultativbooleanStandardwert für neue Marker (siehe Einstellungen)
wms2fakultativbooleanStandardwert für neue Marker (siehe Einstellungen)
wms3fakultativbooleanStandardwert für neue Marker (siehe Einstellungen)
wms4fakultativbooleanStandardwert für neue Marker (siehe Einstellungen)
wms5fakultativbooleanStandardwert für neue Marker (siehe Einstellungen)
wms6fakultativbooleanStandardwert für neue Marker (siehe Einstellungen)
wms7fakultativbooleanStandardwert für neue Marker (siehe Einstellungen)
wms8fakultativbooleanStandardwert für neue Marker (siehe Einstellungen)
wms9fakultativbooleanStandardwert für neue Marker (siehe Einstellungen)
wms10fakultativbooleanStandardwert für neue Marker (siehe Einstellungen)
kml_timestampfakultativDatum (Ymd H: i: s)NULL
AdressefakultativSchnurNULL wird überschrieben, wenn der Parameter Geocode verwendet wird!
gpx_urlfakultativSchnurNULL seit v1.2p
gpx_panelfakultativboolean0 seit v1.2p

nach oben


Verfügbare Parameter für die Textebene

Parameter Erforderlich? Datentyp Standardwert Wichtige Informationen
iderforderlichganze ZahlWird beim Hinzufügen eines neuen Markers automatisch festgelegt
GeocodefakultativSchnurNULL Der Wert wird über die Google Places-API geokodiert und überschreibt die Parameter lat, lon und address
NamefakultativSchnurNULL
Basiskartefakultativvordefinierte WerteStandard-Grundkarte für neue Ebene (siehe Einstellungen) osm_mapnik, mapquest_osm, mapquest_aerial, googleLayer_roadmap, googleLayer_satellite, googleLayer_hybrid, googleLayer_terrain, bingaerial, bingaerialwithlabels, bingroad, ogdwien_basemap, ogdwien_sapap_
Ebenenzoomfakultativganze ZahlStandardzoom für neue Ebene (siehe Einstellungen)
mapwidthunitfakultativSchnurStandardwert für neue Ebene (siehe Einstellungen)
Kartenbreitefakultativganze ZahlStandardzuordnungsbreite für neue Ebene (siehe Einstellungen)
Kartenhöhefakultativganze ZahlStandardkartenhöhe für neue Ebene (siehe Einstellungen)
TafelfakultativbooleanStandardwert für neue Ebene (siehe Einstellungen)
layerviewlatfakultativschwebenStandardlat für neue Ebene (siehe Einstellungen) wird überschrieben, wenn der Parameter Geocode verwendet wird!
LayerviewlonfakultativschwebenStandard-Lon für neue Ebene (siehe Einstellungen) wird überschrieben, wenn der Parameter Geocode verwendet wird!
erstellt vonfakultativSchnurNULL
erstellt amfakultativDatum (Ymd H: i: s)NULL
aktualisiert vonfakultativSchnurNULL
aktualisiert amfakultativDatum (Ymd H: i: s)Datum ('Ymd H: i: s)
KontrollkastenfakultativbooleanStandardwert für neue Ebene (siehe Einstellungen)
Overlays_CustomerforderlichbooleanStandardwert für neue Ebene (siehe Einstellungen)
Overlays_Custom2erforderlichbooleanStandardwert für neue Ebene (siehe Einstellungen)
Overlays_Custom3erforderlichbooleanStandardwert für neue Ebene (siehe Einstellungen)
Overlays_Custom4erforderlichbooleanStandardwert für neue Ebene (siehe Einstellungen)
wmserforderlichbooleanStandardwert für neue Ebene (siehe Einstellungen)
wms2erforderlichbooleanStandardwert für neue Ebene (siehe Einstellungen)
wms3erforderlichbooleanStandardwert für neue Ebene (siehe Einstellungen)
wms4erforderlichbooleanStandardwert für neue Ebene (siehe Einstellungen)
wms5erforderlichbooleanStandardwert für neue Ebene (siehe Einstellungen)
wms6erforderlichbooleanStandardwert für neue Ebene (siehe Einstellungen)
wms7erforderlichbooleanStandardwert für neue Ebene (siehe Einstellungen)
wms8erforderlichbooleanStandardwert für neue Ebene (siehe Einstellungen)
wms9erforderlichbooleanStandardwert für neue Ebene (siehe Einstellungen)
wms10erforderlichbooleanStandardwert für neue Ebene (siehe Einstellungen)
ListenmarkerfakultativbooleanStandardwert für neue Ebene (siehe Einstellungen) Option zum Anzeigen der Liste der Markierungen unter Layer-Maps
multi_layer_mapfakultativboolean0
multi_layer_map_listfakultativZeichenfolge (durch Kommas getrennte Layer-IDs oder alle)NULL zB 1,2,3,4 oder alle
AdressefakultativSchnurNULL wird überschrieben, wenn der Parameter Geocode verwendet wird!
delete_markersfakultativwahr / falschfalsch Bei Verwendung bei einer Löschaktion werden auch zugewiesene Markierungen gelöscht
ClusteringfakultativbooleanStandardwert für neue Ebene (siehe Einstellungen) Nur in der Pro-Version verfügbar
gpx_urlfakultativSchnurNULL seit v1.2p
gpx_panelfakultativboolean0 seit v1.2p


Spezielle Parameter für die Aktion der Markierungsliste

ParameterErforderlich?DatentypWichtige Informationen
BestellschlüsselfakultativSchnurZulässige Sortierreihenfolgewerte: ID, Erstellt auf, Aktualisiert auf, kml_Zeitstempel, Markenname, Grundkarte, Lat, Lon, Erstellt von, Aktualisiert von, Adresse
orderdirfakultativSchnurZulässige Werte für die Sortierrichtung: ASC, DESC
Bestellungfakultativganze ZahlOffset für die Markierungsliste
orderlimitfakultativganze ZahlLimit für die Markierungsliste
nach oben


Spezielle Parameter für die Ebenenlistenaktion

ParameterErforderlich?DatentypWichtige Informationen
BestellschlüsselfakultativSchnurZulässige Werte für die Sortierreihenfolge: ID, Aktualisiert auf, Erstellt auf, Name, Grundkarte, Layerviewlat, Layerviewlon, Erstellt von, Aktualisiert von, Adresse
orderdirfakultativSchnurZulässige Werte für die Sortierrichtung: ASC, DESC
Bestellungfakultativganze ZahlVersatz für die Ebenenliste
orderlimitfakultativganze ZahlLimit für die Ebenenliste
nach oben


Spezielle Parameter für Suchaktionen

ParameterErforderlich?DatentypWichtige Informationen
SuchschlüsselerforderlichSchnurZulässige Suchschlüssel: ID, Markername, Grundkarte, Ebene, Lat, Lon, Symbol, Popuptext, Zoom, OpenPopup, Kartenbreite, Kartenbreite, Kartenhöhe, Bedienfeld, Erstellt von, Erstellt von, Erstellt von, Aktualisiert für, Kontrollkästchen, Overlays_Custom, Overlays_Custom2, Overlays_Custom3, Overlays_Custom4, WMS , wms2, wms3, wms4, wms5, wms6, wms7, wms8, wms9, wms10, kml_timestamp, Adresse, gpx_url, gpx_panel, Name, Layerzoom, Layerviewlat, Layerviewlon, Listmarker, Multi_Layer_Map, Multi_Layer_Map_
SuchwerthängtZeichenfolge oder GanzzahlIm Allgemeinen erforderlich, jedoch optional, wenn der Suchschlüssel erstellt, aktualisiert oder aktualisiert wird
stammen aushängtZeichenfolge (Ymd H: i: s)Im Allgemeinen optional, jedoch erforderlich, wenn der Suchschlüssel erstellt oder aktualisiert wird
Datum bishängtZeichenfolge (Ymd H: i: s)Im Allgemeinen optional, jedoch erforderlich, wenn der Suchschlüssel erstellt oder aktualisiert wird
lat_top_lefthängtfloatval (6)Im Allgemeinen optional, jedoch erforderlich, wenn ein Suchschlüssel-Begrenzungsrahmen verwendet wird
lon_top_lefthängtfloatval (6)Im Allgemeinen optional, jedoch erforderlich, wenn ein Suchschlüssel-Begrenzungsrahmen verwendet wird
lat_bottom_righthängtfloatval (6)Im Allgemeinen optional, jedoch erforderlich, wenn ein Suchschlüssel-Begrenzungsrahmen verwendet wird
lon_bottom_righthängtfloatval (6)Im Allgemeinen optional, jedoch erforderlich, wenn ein Suchschlüssel-Begrenzungsrahmen verwendet wird
nach oben