Uppmärksamhet: MMPAPI har tagits bort med v4.0, ersättning: Databas API

MMPAPI-dokumentation

tillbaka till API-översikten

MMPAPI-funktioner

  1. Introduktion
  2. genererad klassbeskrivning
  3. markörer
    1. add_marker
    2. add_markers
    3. count_markers
    4. delete_marker
    5. ta bort markörer
    6. get_marker
    7. get_markers
    8. listmarkörer
    9. sökmarkörer
    10. uppdateringsmarkör
    11. update_markers
  4. skikt
    1. lägg till lager
    2. add_layers
    3. count_layers
    4. delete_layer
    5. delete_layers
    6. get_layer
    7. get_layers
    8. listlager
    9. search_layers
    10. update_layer
    11. update_layers
  5. behörigheter
    1. current_user_can_any
  6. parametrar
    1. Tillgängliga parametrar för typmarkör
    2. Tillgängliga parametrar för typlager
    3. Särskilda parametrar för markörlista
    4. Speciella parametrar för laglistaåtgärder
    5. Särskilda parametrar för sökning


Introduktion

Maps Marker Pro API-funktioner ger utvecklare ett framtidssäkert sätt att få åtkomst till några av de vanliga kärnfunktionerna i Maps Marker Pro.

API-funktioner inkluderas automatiskt när Maps Marker Pro laddas och de kommer att vara tillgängliga när tilläggsdatum laddas. API-klassen kallas MMPAPI och den kan hittas i /leaflet-maps-marker-pro/inc/class-mmpapi.php.


Genererad klassbeskrivning

Den automatiskt genererade klassbeskrivningen finns på https://www.mapsmarker.com/wp-content/uploads/mmpapi/class/


markörer

add_marker

Lägger till en ny markör med det givna Marker-objektet. Varning, lite kontroll görs för att se till att det är ett giltigt Marker-objekt.

public static function add_marker( $marker_data ) {}

parametrar

Returer

Exempel på användning


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


add_markers

Lägg till markörer baserade på givna dataobjekt.

public static function add_markers( $markers_data ) {}

parametrar

Returer

  • $ markörer blandad

    En rad markörer-ID eller WP_Error-objekt.

Exempel på användning


$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 );
tillbaka till toppen


count_markers

Returnerar antalet tillgängliga markörer.

public static function count_markers( ) {}

Returer

  • $ markers_count int

    Markörerna räknas

Exempel på användning

$result = MMPAPI::count_markers( );
tillbaka till toppen


delete_marker

Tar bort markören med det givna markör-ID.

public static function delete_marker( $marker_id ) {}

parametrar

  • $ marker_id heltal

    Markörens ID som ska raderas.

Returer

Exempel på användning

$result = MMPAPI::delete_marker( $marker_id );
tillbaka till toppen


ta bort markörer

Raderar markörerna för en given markörs-ID

public static function delete_markers( $marker_ids ) {}

parametrar

  • $ marker_ids array

    Markörernas ID.

Returer

  • $ result blandad

    Det är sant om markörerna raderats framgångsrikt, WP_Error objekt om inte.

Exempel på användning


$marker_ids = array(6,7,8);
$result = MMPAPI::delete_markers( $marker_ids );
tillbaka till toppen


get_marker

Returnerar markörobjektet för ett givet markör-ID.

public static function get_marker( $marker_id ) {}

parametrar

  • $ marker_id heltal

    Markörens ID.

Returer

  • $ result blandad

    Markörobjektet eller falskt.

Exempel på användning

$result = MMPAPI::get_marker( 5 );
tillbaka till toppen


get_markers

Returnerar markörobjekten för givna markör-ID.

public static function get_markers( $marker_ids ) {}

parametrar

  • $ marker_ids array

    Markörernas ID.

Returer

  • $ result blandad

    Markören objekt eller falsk.

Exempel på användning

$result = MMPAPI::get_markers( array( 1, 5, 10 ) );
tillbaka till toppen


listmarkörer

Returnerar alla markörobjekt.

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

parametrar

Returer

  • $ result blandad

    Markören objekt eller falsk.

Exempel på användning


$args['orderkey'] = 'markername';
$args['orderdir'] = 'ASC';
$result = MMPAPI::list_markers( $args );
tillbaka till toppen


sökmarkörer

Sökmarkörer objekt för ett givet argument.

public static function search_markers( $args ) {}

parametrar

Returer

  • $ result blandad

    Markörobjekten som matchar parametrarna eller False.

Exempel på användning


$args['searchkey'] = 'layer';
$args['searchvalue'] = 7;
$result = MMPAPI::search_markers( $args );
tillbaka till toppen


uppdateringsmarkör

Uppdaterar en markör baserad på givet dataobjekt

public static function update_marker( $marker_data ) {}

parametrar

Returer

  • $ result boolean

    Sant om markören har uppdaterats, falskt annars.

Exempel på användning


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

$result = MMPAPI::update_marker( $marker_data );
tillbaka till toppen


update_markers

Uppdatera markörer baserat på givet dataobjekt

public static function update_markers( $markers_data ) {}

parametrar

Returer

  • $ result blandad

    Array av ID: er för uppdaterade markörer eller ett felobjekt.

Exempel på användning


$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 );
tillbaka till toppen


skikt

lägg till lager

Lägger till ett nytt lager med det givna lagerobjektet. Varning, lite kontroll görs för att se till att det är ett giltigt lagerobjekt.

public static function add_layer( $layer_data ) {}

parametrar

Returer

Exempel på användning


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


add_layers

Lägg till lager baserade på givna dataobjekt.

public static function add_layers( $layers_data ) {}

parametrar

Returer

  • $ skikt blandad

    En matris med lager-ID: er eller WP_Error-objekt.

Exempel på användning


$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 );
tillbaka till toppen


count_layers

Returnerar antalet tillgängliga lager.

public static function count_layers( ) {}

Returer

  • $ layers_count int

    Skikten räknas

Exempel på användning

$result = MMPAPI::count_layers( );
tillbaka till toppen


delete_layer

Raderar lagret med det givna lager-ID.

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

parametrar

  • $ layer_id heltal

    ID för det lager som ska raderas.

  • $ delete_markers boolean

    En boolesk parameter, om den har ställts in på SANT kommer metoden att ta bort alla markörer som är associerade med skiktet. Standardvärdet är FALSE.

Returer

Exempel på användning

$result = MMPAPI::delete_layer( $layer_id );
tillbaka till toppen


delete_layers

Raderar lagren för ett givet lager-ID

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

parametrar

  • $ layers_ids array

    Lagenes ID: er.

  • $ delete_markers boolean

    En boolesk parameter, om den har satt till SANT kommer metoden att ta bort alla markörer som är associerade med lagren. Standardvärdet är FALSE.

Returer

  • $ result blandad

    Det är sant om lagren raderats framgångsrikt, WP_Error objekt om inte.

Exempel på användning


$layers_ids = array(6,7,8);
$result = MMPAPI::delete_layers( $layers_ids );
tillbaka till toppen


get_layer

Returnerar lagerobjektet för ett givet lager-ID.

public static function get_layer( $layer_id ) {}

parametrar

  • $ layer_id heltal

    Skiktets ID.

Returer

  • $ result blandad

    Skiktobjektet eller falskt.

Exempel på användning

$result = MMPAPI::get_layer( 5 );
tillbaka till toppen


get_layers

Returnerar lagerobjekten för givna lager-ID.

public static function get_layers( $layer_ids ) {}

parametrar

  • $ layer_ids array

    Lagenes ID: er.

Returer

  • $ result blandad

    Skiktet föremål eller falskt.

Exempel på användning

$result = MMPAPI::get_layers( array( 1, 5, 10 ) );
tillbaka till toppen


listlager

Returnerar alla lagerobjekt.

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

parametrar

Returer

  • $ result blandad

    Skiktet föremål eller falskt.

Exempel på användning


$args['orderkey'] = 'name';
$args['orderdir'] = 'ASC';
$result = MMPAPI::list_layers( $args );
tillbaka till toppen


search_layers

Söklager objekt för ett givet argument.

public static function search_layers( $args ) {}

parametrar

Returer

  • $ result blandad

    Skiktobjekten som matchar parametrarna eller False.

Exempel på användning


$args['searchkey'] = 'name';
$args['searchvalue'] = 'Washington';
$result = MMPAPI::search_layers( $args );
tillbaka till toppen


update_layer

Uppdaterar ett lager baserat på givet dataobjekt

public static function update_layer( $layer_data ) {}

parametrar

Returer

  • $ result boolean

    Sant om lagret har uppdaterats, falskt annars.

Exempel på användning


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

$result = MMPAPI::update_layer( $layer_data );
tillbaka till toppen


update_layers

Uppdatera lager baserat på givet dataobjekt

public static function update_layers( $layers_data ) {}

parametrar

Returer

  • $ result blandad

    Array av ID: er för uppdaterade lager eller ett felobjekt.

Exempel på användning


// 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 );
tillbaka till toppen

behörigheter

current_user_can_any

Kontrollerar behörigheterna för den aktuella användaren. Returnerar sant om den aktuella användaren har någon av de angivna funktionerna.

VIKTIGT: Ring detta innan du ringer till någon av de andra API-funktionerna eftersom behörighetskontroller inte utförs på lägre nivåer.

public static function current_user_can_any( $capabilities ) {}

parametrar

  • $ kapacitet blandad

    Sträng om du vill kontrollera bara en kapacitet, eller en matris med flera kapacitet

Returer

Exempel på användning


$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');
}
tillbaka till toppen


parametrar

Tillgängliga parametrar för typmarkör

Parameter Nödvändig? Data typ Standardvärde Anmärkningar
idObligatoriskheltalställs in automatiskt när du lägger till en ny markör
märkesnamnvalfrittsträngNULL
GeocodevalfrittsträngNULL värdet geokodas via Google Places API och skriver över parametern lat, lon och adress
grundkarta valfritt fördefinierade baskarta-ID: er - se anteckningar standard baskarta för ny markör (se inställningar) osm_mapnik, mapquest_osm, mapquest_aerial, googleLayer_roadmap, googleLayer_satellite, googleLayer_hybrid, googleLayer_terrain, bingaerial, bingaerialwithlabels, bingroad, ogdwien_basemap, ochbwapap_2
lager valfritt heltal standardlager för ny markör (se inställningar)
latvalfrittflytastandardplats för ny markör (se inställningar) blir överskriven om parametergeokod används!
lonvalfrittflytastandardplats för ny markör (se inställningar) blir överskriven om parametergeokod används!
ikonvalfrittsträng (t.ex. buss.png)NULL om NULL kommer standardikonen att användas. Använd bara filnamnet på ikonen som anges i exemplet. Alla tillgängliga ikoner i ikonkatalogen (vanligtvis / wp-innehåll / uppladdningar / broschyr-kartor-markör-ikoner om du inte ändrade det i Inställningar / standardvärden / standardvärden för markörikoner) är tillgängliga för användning.
popuptextvalfrittsträngNULL
zoomvalfrittheltalstandardzoom för ny markör (se inställningar)
openpopupvalfrittbooleanstandardvärde för nya markörer (se inställningar)
kartbreddvalfrittheltalstandard kartbredd för nya markörer (se inställningar)
mapwidthunitvalfrittsträngstandardvärde för nya markörer (se inställningar)
karthöjdvalfrittheltalstandard karthöjd för nya markörer (se inställningar)
panelvalfrittbooleanstandardvärde för nya markörer (se inställningar)
skapad avvalfrittsträngNULL
skapad påvalfrittdatum (Ymd H: i: s)NULL
UpdatedByvalfrittsträngNULL
uppdaterad påvalfrittdatum (Ymd H: i: s)datum ('Ymd H: i: s)
kontrollboxvalfrittbooleanstandardvärde för nya markörer (se inställningar)
överlägg_anpassadvalfrittbooleanstandardvärde för nya markörer (se inställningar)
överlägg_custom2valfrittbooleanstandardvärde för nya markörer (se inställningar)
överlägg_custom3valfrittbooleanstandardvärde för nya markörer (se inställningar)
överlägg_custom4valfrittbooleanstandardvärde för nya markörer (se inställningar)
wmsvalfrittbooleanstandardvärde för nya markörer (se inställningar)
wms2valfrittbooleanstandardvärde för nya markörer (se inställningar)
wms3valfrittbooleanstandardvärde för nya markörer (se inställningar)
wms4valfrittbooleanstandardvärde för nya markörer (se inställningar)
wms5valfrittbooleanstandardvärde för nya markörer (se inställningar)
wms6valfrittbooleanstandardvärde för nya markörer (se inställningar)
wms7valfrittbooleanstandardvärde för nya markörer (se inställningar)
wms8valfrittbooleanstandardvärde för nya markörer (se inställningar)
wms9valfrittbooleanstandardvärde för nya markörer (se inställningar)
wms10valfrittbooleanstandardvärde för nya markörer (se inställningar)
kml_timestampvalfrittdatum (Ymd H: i: s)NULL
adressvalfrittsträngNULL blir överskriven om parametergeokod används!
gpx_urlvalfrittsträngNULL sedan v1.2p
gpx_panelvalfrittboolean0 sedan v1.2p

tillbaka till toppen


Tillgängliga parametrar för typlager

Parameter Nödvändig? Data typ Standardvärde Anmärkningar
idObligatoriskheltalställs in automatiskt när du lägger till en ny markör
GeocodevalfrittsträngNULL värdet geokodas via Google Places API och skriver över parametern lat, lon och adress
namnvalfrittsträngNULL
grundkartavalfrittfördefinierade värdenstandard baskarta för nytt lager (se inställningar) osm_mapnik, mapquest_osm, mapquest_aerial, googleLayer_roadmap, googleLayer_satellite, googleLayer_hybrid, googleLayer_terrain, bingaerial, bingaerialwithlabels, bingroad, ogdwien_basemap, ochbwapap_2
lagerzoomvalfrittheltalstandardzoom för nytt lager (se inställningar)
mapwidthunitvalfrittsträngstandardvärde för nytt lager (se inställningar)
kartbreddvalfrittheltalstandard kartbredd för nytt lager (se inställningar)
karthöjdvalfrittheltalstandard karthöjd för nytt lager (se inställningar)
panelvalfrittbooleanstandardvärde för nytt lager (se inställningar)
layerviewlatvalfrittflytastandard lat för nytt lager (se inställningar) blir överskriven om parametergeokod används!
layerviewlonvalfrittflytastandardlon för nytt lager (se inställningar) blir överskriven om parametergeokod används!
skapad avvalfrittsträngNULL
skapad påvalfrittdatum (Ymd H: i: s)NULL
UpdatedByvalfrittsträngNULL
uppdaterad påvalfrittdatum (Ymd H: i: s)datum ('Ymd H: i: s)
kontrollboxvalfrittbooleanstandardvärde för nytt lager (se inställningar)
överlägg_anpassadObligatoriskbooleanstandardvärde för nytt lager (se inställningar)
överlägg_custom2Obligatoriskbooleanstandardvärde för nytt lager (se inställningar)
överlägg_custom3Obligatoriskbooleanstandardvärde för nytt lager (se inställningar)
överlägg_custom4Obligatoriskbooleanstandardvärde för nytt lager (se inställningar)
wmsObligatoriskbooleanstandardvärde för nytt lager (se inställningar)
wms2Obligatoriskbooleanstandardvärde för nytt lager (se inställningar)
wms3Obligatoriskbooleanstandardvärde för nytt lager (se inställningar)
wms4Obligatoriskbooleanstandardvärde för nytt lager (se inställningar)
wms5Obligatoriskbooleanstandardvärde för nytt lager (se inställningar)
wms6Obligatoriskbooleanstandardvärde för nytt lager (se inställningar)
wms7Obligatoriskbooleanstandardvärde för nytt lager (se inställningar)
wms8Obligatoriskbooleanstandardvärde för nytt lager (se inställningar)
wms9Obligatoriskbooleanstandardvärde för nytt lager (se inställningar)
wms10Obligatoriskbooleanstandardvärde för nytt lager (se inställningar)
listmarkörervalfrittbooleanstandardvärde för nytt lager (se inställningar) alternativ för att visa en lista över markörer under lagerkartor
flerlager_kartavalfrittboolean0
flerlager_karta_listavalfrittsträng (kommaseparerade lager-ID eller alla)NULL t.ex. 1,2,3,4 eller alla
adressvalfrittsträngNULL blir överskriven om parametergeokod används!
ta bort markörervalfrittsant falsktfalsk när de används vid radering raderas också tilldelade markörer
klustringvalfrittbooleanstandardvärde för nytt lager (se inställningar) endast tillgänglig i proversion
gpx_urlvalfrittsträngNULL sedan v1.2p
gpx_panelvalfrittboolean0 sedan v1.2p


Särskilda parametrar för markörlista

ParameterNödvändig?Data typAnmärkningar
ordernyckelvalfrittsträngTillåtna sorteringsvärden: id, skapad, uppdaterad, kml_timestamp, marknamn, baskarta, lat, lon, skapad, uppdaterad, adress, adress
orderdirvalfrittsträngTillåtna sorteringsriktningsvärden: ASC, DESC
orderoffvalfrittheltalOffset för markörlistan
orderbegränsningvalfrittheltalBegränsning för markörlistan
tillbaka till toppen


Speciella parametrar för laglistaåtgärder

ParameterNödvändig?Data typAnmärkningar
ordernyckelvalfrittsträngTillåtna sorteringsvärden: id, uppdaterad, skapad, namn, baskarta, layerviewlat, layerviewlon, createby, updatedby, adress
orderdirvalfrittsträngTillåtna sorteringsriktningsvärden: ASC, DESC
orderoffvalfrittheltalFörskjutning för lagerlistan
orderbegränsningvalfrittheltalBegränsning för lagerlistan
tillbaka till toppen


Särskilda parametrar för sökning

ParameterNödvändig?Data typAnmärkningar
söknyckelObligatorisksträngTillåtna söknycklar: id, märknamn, baskarta, lager, lat, lon, ikon, popuptext, zoom, openpopup, kartbredd, kartbredd, karthöjd, panel, skapad, skapad, uppdaterad, uppdaterad, kontrollbox, överlägg_anpassad, överlägg_kund2, överlägg_custom3, överlägg_custom4, wms , wms2, wms3, wms4, wms5, wms6, wms7, wms8, wms9, wms10, kml_timestamp, adress, gpx_url, gpx_panel, namn, layerzoom, layerviewlat, layerviewlon, listmarkers, multi_layer_map, multi_layer_map_list, clippinglist
sökvärdeberorsträng eller heltali allmänhet krävs men valfritt när du använder söknyckel skapad, uppdaterad eller gränslåda
datum frånberorsträng (Ymd H: i: s)vanligtvis valfritt men krävs när du använder söknyckel skapad eller uppdaterad
datum_toberorsträng (Ymd H: i: s)vanligtvis valfritt men krävs när du använder söknyckel skapad eller uppdaterad
lat_top_leftberorfloatval (6)vanligtvis valfritt men krävs när du använder söknyckelsamling
lon_top_leftberorfloatval (6)vanligtvis valfritt men krävs när du använder söknyckelsamling
lat_bottom_rightberorfloatval (6)vanligtvis valfritt men krävs när du använder söknyckelsamling
lon_bottom_rightberorfloatval (6)vanligtvis valfritt men krävs när du använder söknyckelsamling
tillbaka till toppen