Opmærkning: MMPAPI er blevet fjernet med v4.0, erstatning: Database API

MMPAPI-dokumentation

tilbage til API-oversigt

MMPAPI-funktioner

  1. Introduktion
  2. genereret klassebeskrivelse
  3. Markers
    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. Lag
    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. Tilladelser
    1. current_user_can_any
  6. parametre
    1. Tilgængelige parametre til typemarkering
    2. Tilgængelige parametre til typelag
    3. Særlige parametre til markørlistehandling
    4. Særlige parametre til laglistehandling
    5. Særlige parametre til søgning


Introduktion

Maps Marker Pro API-funktioner giver udviklere en fremtidssikker måde at få adgang til nogle af de fælles kernefunktioner i Maps Marker Pro.

API-funktionerne inkluderes automatisk, når Maps Marker Pro indlæses, og de vil være tilgængelige, når tilføjelsestidspunktet indlæses. API-klassen kaldes MMPAPI og den kan findes i /leaflet-maps-marker-pro/inc/class-mmpapi.php.


Genereret klassebeskrivelse

Den automatisk genererede klassebeskrivelse kan findes på https://www.mapsmarker.com/wp-content/uploads/mmpapi/class/


Markers

add_marker

Tilføjer en ny markør ved hjælp af det givne Marker-objekt. Advarsel, der foretages lidt kontrol for at sikre, at det er et gyldigt Marker-objekt.

public static function add_marker( $marker_data ) {}

parametre

Returnering

Anvendelseseksempel


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


add_markers

Tilføj markører baseret på givne dataobjekter.

public static function add_markers( $markers_data ) {}

parametre

Returnering

  • $ markører blandet

    En række markør-id'er eller WP_Error-objekt.

Anvendelseseksempel


$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 );
Tilbage til toppen


count_markers

Returnerer antallet af tilgængelige markører.

public static function count_markers( ) {}

Returnering

  • $ markers_count int

    Markørerne tæller

Anvendelseseksempel

$result = MMPAPI::count_markers( );
Tilbage til toppen


delete_marker

Sletter markøren med det givne markør-id.

public static function delete_marker( $marker_id ) {}

parametre

  • $ marker_id heltal

    ID'et for den markør, der skal slettes.

Returnering

Anvendelseseksempel

$result = MMPAPI::delete_marker( $marker_id );
Tilbage til toppen


delete_markers

Sletter markørerne for et givet markør-id'er

public static function delete_markers( $marker_ids ) {}

parametre

  • $ marker_ids matrix

    Markørernes ID'er.

Returnering

  • $ resultat blandet

    Sandt, hvis markørerne blev slettet, WP_Error objekt, hvis ikke.

Anvendelseseksempel


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


get_marker

Returnerer markørobjektet for et givet markør-id.

public static function get_marker( $marker_id ) {}

parametre

  • $ marker_id heltal

    Markørenes ID.

Returnering

  • $ resultat blandet

    Markørobjektet eller falsk.

Anvendelseseksempel

$result = MMPAPI::get_marker( 5 );
Tilbage til toppen


get_markers

Returnerer markørobjekterne for givne markør-id'er.

public static function get_markers( $marker_ids ) {}

parametre

  • $ marker_ids matrix

    Markørernes ID'er.

Returnering

  • $ resultat blandet

    Markøren objekter eller falsk.

Anvendelseseksempel

$result = MMPAPI::get_markers( array( 1, 5, 10 ) );
Tilbage til toppen


list_markers

Returnerer alle markørobjekter.

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

parametre

Returnering

  • $ resultat blandet

    Markøren objekter eller falsk.

Anvendelseseksempel


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


search_markers

Søgemærker gør indsigelse mod et givet argument.

public static function search_markers( $args ) {}

parametre

Returnering

  • $ resultat blandet

    Markørobjekter, der matcher parametrene eller False.

Anvendelseseksempel


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


update_marker

Opdaterer en markør baseret på et givet dataobjekt

public static function update_marker( $marker_data ) {}

parametre

Returnering

  • $ resultat boolean

    Sandt, hvis markøren er blevet opdateret, falsk ellers.

Anvendelseseksempel


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

$result = MMPAPI::update_marker( $marker_data );
Tilbage til toppen


update_markers

Opdater markører baseret på et givet dataobjekt

public static function update_markers( $markers_data ) {}

parametre

Returnering

  • $ resultat blandet

    Array af ID'er for opdaterede markører eller et fejlobjekt.

Anvendelseseksempel


$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 );
Tilbage til toppen


Lag

add_layer

Tilføjer et nyt lag ved hjælp af det givne Layer-objekt. Advarsel, der kontrolleres kun lidt for at sikre, at det er et gyldigt lag-objekt.

public static function add_layer( $layer_data ) {}

parametre

Returnering

Anvendelseseksempel


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


add_layers

Tilføj lag baseret på givne dataobjekter.

public static function add_layers( $layers_data ) {}

parametre

Returnering

  • $ lag blandet

    En række lag-id'er eller WP_Error-objekt.

Anvendelseseksempel


$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 );
Tilbage til toppen


count_layers

Returnerer antallet af tilgængelige lag.

public static function count_layers( ) {}

Returnering

  • $ layers_count int

    Lagene tæller

Anvendelseseksempel

$result = MMPAPI::count_layers( );
Tilbage til toppen


delete_layer

Sletter laget med det givne lag-id.

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

parametre

  • $ layer_id heltal

    ID'et for det lag, der skal slettes.

  • $ delete_markers boolean

    En boolsk parameter, hvis den er indstillet til SAND, vil metoden slette alle markører, der er tilknyttet laget. Standardværdien er FALSE.

Returnering

Anvendelseseksempel

$result = MMPAPI::delete_layer( $layer_id );
Tilbage til toppen


delete_layers

Sletter lagene for et givet lag-id

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

parametre

  • $ layers_ids matrix

    Lagernes ID'er.

  • $ delete_markers boolean

    En boolsk parameter, hvis den er indstillet til SAND, vil metoden slette alle markører, der er tilknyttet lagene. Standardværdien er FALSE.

Returnering

  • $ resultat blandet

    Sandt, hvis lagene er slettet med succes, WP_Error objekt, hvis ikke.

Anvendelseseksempel


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


get_layer

Returnerer lagobjektet for et givet lag-id.

public static function get_layer( $layer_id ) {}

parametre

  • $ layer_id heltal

    Lagets ID.

Returnering

  • $ resultat blandet

    Lagobjektet eller falsk.

Anvendelseseksempel

$result = MMPAPI::get_layer( 5 );
Tilbage til toppen


get_layers

Returnerer lagobjekterne for de givne lag-id'er.

public static function get_layers( $layer_ids ) {}

parametre

  • $ layer_ids matrix

    Lagernes ID'er.

Returnering

  • $ resultat blandet

    Laget er objekter eller falsk.

Anvendelseseksempel

$result = MMPAPI::get_layers( array( 1, 5, 10 ) );
Tilbage til toppen


list_layers

Returnerer alle lagobjekter.

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

parametre

Returnering

  • $ resultat blandet

    Laget er objekter eller falsk.

Anvendelseseksempel


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


search_layers

Søgning lag objekt for en given argumenter.

public static function search_layers( $args ) {}

parametre

Returnering

  • $ resultat blandet

    Lagene objekter, der matcher parametrene eller False.

Anvendelseseksempel


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


update_layer

Opdaterer et lag baseret på et givet dataobjekt

public static function update_layer( $layer_data ) {}

parametre

Returnering

  • $ resultat boolean

    Sandt, hvis laget er blevet opdateret, falsk ellers.

Anvendelseseksempel


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

$result = MMPAPI::update_layer( $layer_data );
Tilbage til toppen


update_layers

Opdater lag baseret på et givet dataobjekt

public static function update_layers( $layers_data ) {}

parametre

Returnering

  • $ resultat blandet

    Array af ID'er for opdaterede lag eller et fejlobjekt.

Anvendelseseksempel


// 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 );
Tilbage til toppen

Tilladelser

current_user_can_any

Kontrollerer tilladelserne for den aktuelle bruger. Returnerer sandt, hvis den aktuelle bruger har en af ​​de specificerede muligheder.

VIGTIGT: Ring til dette, før du ringer til nogen af ​​de andre API-funktioner, da tilladelseskontrol ikke udføres på lavere niveauer.

public static function current_user_can_any( $capabilities ) {}

parametre

  • $ kapaciteter blandet

    Streng, hvis du vil kontrollere kun en kapacitet, eller en række multiple kapaciteter

Returnering

Anvendelseseksempel


$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');
}
Tilbage til toppen


parametre

Tilgængelige parametre til typemarkering

Parameter Nødvendig? Datatype Standard værdi Noter
idpåkrævetheltalindstilles automatisk, når du tilføjer en ny markør
markernamevalgfristrengNULL
GeocodevalgfristrengNULL værdi bliver kodet via Google Places API og overskriver parameter lat, lon og adresse
konturkortet valgfri foruddefinerede basemap-id'er - se noter standard basemap for ny markør (se indstillinger) osm_mapnik, mapquest_osm, mapquest_aerial, googleLayer_roadmap, googleLayer_satellite, googleLayer_hybrid, googleLayer_terrain, bingaerial, bingaerialwithlabels, bingroad, ogdwien_basemap, ogboxwashap,
lag valgfri heltal standardlag til ny markør (se indstillinger)
latvalgfriflydestandard placering for ny markør (se indstillinger) bliver overskrevet, hvis parameter geocode bruges!
lonvalgfriflydestandard placering for ny markør (se indstillinger) bliver overskrevet, hvis parameter geocode bruges!
ikonvalgfristreng (f.eks bus.png)NULL Hvis NULL, bruges standardikonet. Brug bare filnavnet på ikonet som angivet i eksemplet. Alle tilgængelige ikoner i ikonbiblioteket (normalt / wp-indhold / uploads / folder / kort-markør-ikoner, hvis du ikke ændrede det i Indstillinger / kortindstillinger / standardværdier for markørikoner) er tilgængelige til brug.
popuptextvalgfristrengNULL
zoomvalgfriheltalstandard zoom for ny markør (se indstillinger)
openpopupvalgfribooleanstandardværdi for nye markører (se indstillinger)
mapwidthvalgfriheltalstandard kortbredde for nye markører (se indstillinger)
mapwidthunitvalgfristrengstandardværdi for nye markører (se indstillinger)
mapheightvalgfriheltalstandard korthøjde for nye markører (se indstillinger)
panelvalgfribooleanstandardværdi for nye markører (se indstillinger)
lavet afvalgfristrengNULL
createdonvalgfridato (Ymd H: i: s)NULL
UpdatedByvalgfristrengNULL
updatedonvalgfridato (Ymd H: i: s)dato ('Ymd H: i: s)
kontrol boksvalgfribooleanstandardværdi for nye markører (se indstillinger)
overlays_customvalgfribooleanstandardværdi for nye markører (se indstillinger)
overlays_custom2valgfribooleanstandardværdi for nye markører (se indstillinger)
overlays_custom3valgfribooleanstandardværdi for nye markører (se indstillinger)
overlays_custom4valgfribooleanstandardværdi for nye markører (se indstillinger)
wmsvalgfribooleanstandardværdi for nye markører (se indstillinger)
wms2valgfribooleanstandardværdi for nye markører (se indstillinger)
wms3valgfribooleanstandardværdi for nye markører (se indstillinger)
wms4valgfribooleanstandardværdi for nye markører (se indstillinger)
wms5valgfribooleanstandardværdi for nye markører (se indstillinger)
wms6valgfribooleanstandardværdi for nye markører (se indstillinger)
wms7valgfribooleanstandardværdi for nye markører (se indstillinger)
wms8valgfribooleanstandardværdi for nye markører (se indstillinger)
wms9valgfribooleanstandardværdi for nye markører (se indstillinger)
wms10valgfribooleanstandardværdi for nye markører (se indstillinger)
kml_timestampvalgfridato (Ymd H: i: s)NULL
adressevalgfristrengNULL bliver overskrevet, hvis parameter geocode bruges!
gpx_urlvalgfristrengNULL siden v1.2p
gpx_panelvalgfriboolean0 siden v1.2p

Tilbage til toppen


Tilgængelige parametre til typelag

Parameter Nødvendig? Datatype Standard værdi Noter
idpåkrævetheltalindstilles automatisk, når du tilføjer en ny markør
GeocodevalgfristrengNULL værdi bliver kodet via Google Places API og overskriver parameter lat, lon og adresse
navnvalgfristrengNULL
konturkortetvalgfriforuddefinerede værdierstandard basemap for nyt lag (se indstillinger) osm_mapnik, mapquest_osm, mapquest_aerial, googleLayer_roadmap, googleLayer_satellite, googleLayer_hybrid, googleLayer_terrain, bingaerial, bingaerialwithlabels, bingroad, ogdwien_basemap, ogboxwashap,
layerzoomvalgfriheltalstandard zoom for nyt lag (se indstillinger)
mapwidthunitvalgfristrengstandardværdi for nyt lag (se indstillinger)
mapwidthvalgfriheltalstandard kortbredde for nyt lag (se indstillinger)
mapheightvalgfriheltalstandard korthøjde for nyt lag (se indstillinger)
panelvalgfribooleanstandardværdi for nyt lag (se indstillinger)
layerviewlatvalgfriflydestandard lat for nyt lag (se indstillinger) bliver overskrevet, hvis parameter geocode bruges!
layerviewlonvalgfriflydestandardlon for nyt lag (se indstillinger) bliver overskrevet, hvis parameter geocode bruges!
lavet afvalgfristrengNULL
createdonvalgfridato (Ymd H: i: s)NULL
UpdatedByvalgfristrengNULL
updatedonvalgfridato (Ymd H: i: s)dato ('Ymd H: i: s)
kontrol boksvalgfribooleanstandardværdi for nyt lag (se indstillinger)
overlays_custompåkrævetbooleanstandardværdi for nyt lag (se indstillinger)
overlays_custom2påkrævetbooleanstandardværdi for nyt lag (se indstillinger)
overlays_custom3påkrævetbooleanstandardværdi for nyt lag (se indstillinger)
overlays_custom4påkrævetbooleanstandardværdi for nyt lag (se indstillinger)
wmspåkrævetbooleanstandardværdi for nyt lag (se indstillinger)
wms2påkrævetbooleanstandardværdi for nyt lag (se indstillinger)
wms3påkrævetbooleanstandardværdi for nyt lag (se indstillinger)
wms4påkrævetbooleanstandardværdi for nyt lag (se indstillinger)
wms5påkrævetbooleanstandardværdi for nyt lag (se indstillinger)
wms6påkrævetbooleanstandardværdi for nyt lag (se indstillinger)
wms7påkrævetbooleanstandardværdi for nyt lag (se indstillinger)
wms8påkrævetbooleanstandardværdi for nyt lag (se indstillinger)
wms9påkrævetbooleanstandardværdi for nyt lag (se indstillinger)
wms10påkrævetbooleanstandardværdi for nyt lag (se indstillinger)
listmarkersvalgfribooleanstandardværdi for nyt lag (se indstillinger) mulighed for at vise liste over markører under lagkort
multi_layer_mapvalgfriboolean0
multi_layer_map_listvalgfristreng (komma-separeret lag-ID'er eller alle)NULL f.eks. 1,2,3,4 eller alle
adressevalgfristrengNULL bliver overskrevet, hvis parameter geocode bruges!
delete_markersvalgfrisandt falskfalsk når de bruges til sletning, slettes også tildelte markører
klyngedannelsevalgfribooleanstandardværdi for nyt lag (se indstillinger) kun tilgængelig i pro version
gpx_urlvalgfristrengNULL siden v1.2p
gpx_panelvalgfriboolean0 siden v1.2p


Særlige parametre til markørlistehandling

ParameterNødvendig?DatatypeNoter
orderkeyvalgfristrengTilladte sorteringsværdier: id, oprettet, opdateret, kml_timestamp, marknavn, basekort, lat, lon, oprettet by, opdateretby, adresse
orderdirvalgfristrengTilladte sorteringsværdier: ASC, DESC
orderoffvalgfriheltalOffset til markørlisten
orderlimitvalgfriheltalBegrænsning af markørlisten
Tilbage til toppen


Særlige parametre til laglistehandling

ParameterNødvendig?DatatypeNoter
orderkeyvalgfristrengTilladte sorteringsværdier: id, opdateret, oprettet, navn, basiskort, lagerviewlat, layerviewlon, oprettetby, opdateretby, adresse
orderdirvalgfristrengTilladte sorteringsværdier: ASC, DESC
orderoffvalgfriheltalOffset til laglisten
orderlimitvalgfriheltalBegrænsning for laglisten
Tilbage til toppen


Særlige parametre til søgning

ParameterNødvendig?DatatypeNoter
searchkeypåkrævetstrengTilladte nøgler: id, marknavn, basemap, lag, lat, lon, ikon, popup-tekst, zoom, openpopup, mapwidth, mapwidthunit, mapheight, panel, createby, createon, updatedby, updatedon, controlbox, 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, navn, layerzoom, layerviewlat, layerviewlon, listmarkers, multi_layer_map, multi_layer_map_list, clipping,
searchvalueafhængerstreng eller heltalgenerelt krævet, men valgfri, når du bruger søgeord opretteton, opdatereton eller indbindingskasse
dato fraafhængerstreng (Ymd H: i: s)generelt valgfri, men krævet, når du bruger søgeord oprettet eller opdateret
date_toafhængerstreng (Ymd H: i: s)generelt valgfri, men krævet, når du bruger søgeord oprettet eller opdateret
lat_top_leftafhængerfloatval (6)generelt valgfri men påkrævet, når du bruger søgeordsbindingskasse
lon_top_leftafhængerfloatval (6)generelt valgfri men påkrævet, når du bruger søgeordsbindingskasse
lat_bottom_rightafhængerfloatval (6)generelt valgfri men påkrævet, når du bruger søgeordsbindingskasse
lon_bottom_rightafhængerfloatval (6)generelt valgfri men påkrævet, når du bruger søgeordsbindingskasse
Tilbage til toppen