注意:MMPAPI已被v4.0删除,替换为: 数据库API

MMPAPI文档

返回API概述

MMPAPI函数

  1. 简介
  2. 生成的类描述
  3. 标记
    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
    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
  4. 权限
    1. current_user_can_any
  5. 参数
    1. 类型标记的可用参数
    2. 类型图层的可用参数
    3. 标记列表操作的特殊参数
    4. 图层列表动作的特殊参数
    5. 搜索动作的特殊参数


简介

Maps Marker Pro API函数为开发人员提供了一种面向未来的方法,可以访问Maps Marker Pro中的某些常见核心功能。

加载Maps Marker Pro时,API函数会自动包含在内,并且在加载加载项时将可用。 该API类称为MMPAPI,可以在/leaflet-maps-marker-pro/inc/class-mmpapi.php中找到。


生成的类描述

自动生成的类说明可在以下位置找到 https://www.mapsmarker.com/wp-content/uploads/mmpapi/class/


标记

add_marker

使用给定的Marker对象添加一个新的标记。 警告,很少进行检查以确保它是有效的Marker对象。

public static function add_marker( $marker_data ) {}

参数

退货须知

使用范例


$marker_data = array(
	'markername' => 'Headquarter',
	'geocode' => 'Main Street 1 Washington',
);
$marker_id = MMPAPI::add_marker( $marker_data );
回到顶部


add_markers

根据给定的数据对象添加标记。

public static function add_markers( $markers_data ) {}

参数

退货须知

  • $ markers

    标记ID或WP_Error对象的数组。

使用范例


$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 );
回到顶部


count_markers

返回可用的标记数。

public static function count_markers( ) {}

退货须知

  • $ markers_count INT

    标记数

使用范例

$result = MMPAPI::count_markers( );
回到顶部


delete_marker

删除具有给定标记ID的标记。

public static function delete_marker( $marker_id ) {}

参数

  • $ marker_id 整数

    要删除的标记的ID。

退货须知

使用范例

$result = MMPAPI::delete_marker( $marker_id );
回到顶部


delete_markers

删除给定标记ID的标记

public static function delete_markers( $marker_ids ) {}

参数

  • $ marker_ids 排列

    标记的ID。

退货须知

  • $结果

    如果标记成功删除,则为True, WP_Error 如果没有反对。

使用范例


$marker_ids = array(6,7,8);
$result = MMPAPI::delete_markers( $marker_ids );
回到顶部


get_marker

返回给定标记ID的标记对象。

public static function get_marker( $marker_id ) {}

参数

  • $ marker_id 整数

    标记的ID。

退货须知

  • $结果

    标记对象或False。

使用范例

$result = MMPAPI::get_marker( 5 );
回到顶部


get_markers

返回给定标记ID的标记对象。

public static function get_markers( $marker_ids ) {}

参数

  • $ marker_ids 排列

    标记的ID。

退货须知

  • $结果

    标记对象或False。

使用范例

$result = MMPAPI::get_markers( array( 1, 5, 10 ) );
回到顶部


list_markers

返回所有标记对象。

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

参数

退货须知

  • $结果

    标记对象或False。

使用范例


$args['orderkey'] = 'markername';
$args['orderdir'] = 'ASC';
$result = MMPAPI::list_markers( $args );
回到顶部


search_markers

搜索标记对象用于给定参数。

public static function search_markers( $args ) {}

参数

退货须知

  • $结果

    与参数匹配的标记对象或False。

使用范例


$args['searchkey'] = 'layer';
$args['searchvalue'] = 7;
$result = MMPAPI::search_markers( $args );
回到顶部


update_marker

根据给定的数据对象更新标记

public static function update_marker( $marker_data ) {}

参数

退货须知

  • $结果 布尔

    如果标记已更新,则为true,否则为false。

使用范例


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

$result = MMPAPI::update_marker( $marker_data );
回到顶部


update_markers

根据给定的数据对象更新标记

public static function update_markers( $markers_data ) {}

参数

退货须知

  • $结果

    更新标记或错误对象的ID数组。

使用范例


$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 );
回到顶部


add_layer

使用给定的Layer对象添加一个新层。 警告,请稍做检查以确保它是有效的Layer对象。

public static function add_layer( $layer_data ) {}

参数

退货须知

使用范例


$layer_data = array(
	'name' => 'Headquarter',
	'geocode' => 'Main Street 1 Washington',
);
$layer_id = MMPAPI::add_layer( $layer_data );
回到顶部


add_layers

根据给定的数据对象添加图层。

public static function add_layers( $layers_data ) {}

参数

退货须知

  • $层

    层ID或WP_Error对象的数组。

使用范例


$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 );
回到顶部


count_layers

返回可用的层数。

public static function count_layers( ) {}

退货须知

  • $ layers_count INT

    层数

使用范例

$result = MMPAPI::count_layers( );
回到顶部


delete_layer

删除具有给定图层ID的图层。

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

参数

  • $ layer_id 整数

    要删除的图层的ID。

  • $ delete_markers 布尔

    布尔参数,如果已设置为TRUE,则该方法将删除与该图层关联的所有标记。 默认值为FALSE。

退货须知

使用范例

$result = MMPAPI::delete_layer( $layer_id );
回到顶部


delete_layers

删除给定图层ID的图层

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

参数

  • $ layers_ids 排列

    层的ID。

  • $ delete_markers 布尔

    布尔参数(如果已设置为TRUE),该方法将删除与图层关联的所有标记。 默认值为FALSE。

退货须知

  • $结果

    如果图层删除成功,则为True, WP_Error 如果没有反对。

使用范例


$layers_ids = array(6,7,8);
$result = MMPAPI::delete_layers( $layers_ids );
回到顶部


get_layer

返回给定图层ID的图层对象。

public static function get_layer( $layer_id ) {}

参数

  • $ layer_id 整数

    层的ID。

退货须知

  • $结果

    图层对象或False。

使用范例

$result = MMPAPI::get_layer( 5 );
回到顶部


get_layers

返回给定图层ID的图层对象。

public static function get_layers( $layer_ids ) {}

参数

  • $ layer_ids 排列

    层的ID。

退货须知

  • $结果

    图层对象或False。

使用范例

$result = MMPAPI::get_layers( array( 1, 5, 10 ) );
回到顶部


list_layers

返回所有图层对象。

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

参数

退货须知

  • $结果

    图层对象或False。

使用范例


$args['orderkey'] = 'name';
$args['orderdir'] = 'ASC';
$result = MMPAPI::list_layers( $args );
回到顶部


search_layers

搜索图层对象以查找给定参数。

public static function search_layers( $args ) {}

参数

退货须知

  • $结果

    匹配参数或False的图层对象。

使用范例


$args['searchkey'] = 'name';
$args['searchvalue'] = 'Washington';
$result = MMPAPI::search_layers( $args );
回到顶部


update_layer

根据给定的数据对象更新图层

public static function update_layer( $layer_data ) {}

参数

退货须知

  • $结果 布尔

    如果图层已更新,则为true,否则为false。

使用范例


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

$result = MMPAPI::update_layer( $layer_data );
回到顶部


update_layers

根据给定的数据对象更新图层

public static function update_layers( $layers_data ) {}

参数

退货须知

  • $结果

    更新图层或错误对象的ID数组。

使用范例


// 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 );
回到顶部

权限

current_user_can_any

检查当前用户的权限。 如果当前用户具有任何指定功能,则返回true。

重要说明:调用此API之前,请先调用此函数,因为不会在较低级别上执行权限检查。

public static function current_user_can_any( $capabilities ) {}

参数

  • $功能

    如果只想检查一项功能,还是要检查多项功能,则为字符串 能力

退货须知

使用范例


$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');
}
回到顶部


参数

类型标记的可用参数

产品型号 需要? 数据类型 默认值 说明
id必须整数添加新标记时自动设置
标记名可选绳子
地理编码可选绳子 通过Google Places API对值进行地理编码,并覆盖参数lat,lon和address
底图 可选 预定义的底图ID-请参见注释 新标记的默认底图(请参阅设置) osm_mapnik,mapquest_osm,mapquest_aerial,googleLayer_roadmap,googleLayer_satellite,googleLayer_hybrid,googleLayer_terrain,bingaerial,bingaerialwithlabels,bingroad,ogdwien_basemap,ogdwien_satellite,mapbox,map2,map_map,map_map,base_map_base,map_custom,map3,map_base,map2,base_map_base,map3,map_map,map_map,base_map_base,map_custom
可选 整数 新标记的默认图层(请参阅设置)
纬度可选浮动新标记的默认位置(请参阅设置) 如果使用参数地址解析将被覆盖!
LON可选浮动新标记的默认位置(请参阅设置) 如果使用参数地址解析将被覆盖!
图标可选字符串(例如bus.png) 如果为NULL,将使用默认图标。 请按照示例中的说明使用图标的文件名。 可以使用图标目录中所有可用的图标(如果未在“设置” /“地图默认值” /“标记图标的默认值”中更改过,则通常是/ wp-content / uploads / leaflet-maps-marker-icons)。
popuptext可选绳子
放大可选整数新标记的默认缩放(请参阅设置)
openpopup可选布尔新标记的默认值(请参阅设置)
地图宽度可选整数新标记的默认地图宽度(请参阅设置)
mapwidthunit可选绳子新标记的默认值(请参阅设置)
高度可选整数新标记的默认地图高度(请参阅设置)
面板可选布尔新标记的默认值(请参阅设置)
由...制作可选绳子
创建于可选日期(Ymd H:i:s)
更新时间:可选绳子
更新时间可选日期(Ymd H:i:s)日期('Ymd H:i:s)
控制箱可选布尔新标记的默认值(请参阅设置)
overlays_custom可选布尔新标记的默认值(请参阅设置)
overlays_custom2可选布尔新标记的默认值(请参阅设置)
overlays_custom3可选布尔新标记的默认值(请参阅设置)
overlays_custom4可选布尔新标记的默认值(请参阅设置)
WMS可选布尔新标记的默认值(请参阅设置)
wms2可选布尔新标记的默认值(请参阅设置)
wms3可选布尔新标记的默认值(请参阅设置)
wms4可选布尔新标记的默认值(请参阅设置)
wms5可选布尔新标记的默认值(请参阅设置)
wms6可选布尔新标记的默认值(请参阅设置)
wms7可选布尔新标记的默认值(请参阅设置)
wms8可选布尔新标记的默认值(请参阅设置)
wms9可选布尔新标记的默认值(请参阅设置)
wms10可选布尔新标记的默认值(请参阅设置)
kml_timestamp可选日期(Ymd H:i:s)
地址可选绳子 如果使用参数地址解析将被覆盖!
gpx_url可选绳子 从v1.2p开始
gpx_panel可选布尔0 从v1.2p开始

回到顶部


类型图层的可用参数

产品型号 需要? 数据类型 默认值 说明
id必须整数添加新标记时自动设置
地理编码可选绳子 通过Google Places API对值进行地理编码,并覆盖参数lat,lon和address
名称可选绳子
底图可选预定义值新图层的默认底图(请参阅设置) osm_mapnik,mapquest_osm,mapquest_aerial,googleLayer_roadmap,googleLayer_satellite,googleLayer_hybrid,googleLayer_terrain,bingaerial,bingaerialwithlabels,bingroad,ogdwien_basemap,ogdwien_satellite,mapbox,map2,map_map,map_map,base_map_base,map_custom,map3,map_base,map2,base_map_base,map3,map_map,map_map,base_map_base,map_custom
图层缩放可选整数新图层的默认缩放(请参阅设置)
mapwidthunit可选绳子新图层的默认值(请参阅设置)
地图宽度可选整数新图层的默认地图宽度(请参阅设置)
高度可选整数新图层的默认mapheight(请参阅设置)
面板可选布尔新图层的默认值(请参阅设置)
layerviewlat可选浮动新图层的默认纬度(请参阅设置) 如果使用参数地址解析将被覆盖!
Layerviewlon可选浮动新图层的默认lon(请参阅设置) 如果使用参数地址解析将被覆盖!
由...制作可选绳子
创建于可选日期(Ymd H:i:s)
更新时间:可选绳子
更新时间可选日期(Ymd H:i:s)日期('Ymd H:i:s)
控制箱可选布尔新图层的默认值(请参阅设置)
overlays_custom必须布尔新图层的默认值(请参阅设置)
overlays_custom2必须布尔新图层的默认值(请参阅设置)
overlays_custom3必须布尔新图层的默认值(请参阅设置)
overlays_custom4必须布尔新图层的默认值(请参阅设置)
WMS必须布尔新图层的默认值(请参阅设置)
wms2必须布尔新图层的默认值(请参阅设置)
wms3必须布尔新图层的默认值(请参阅设置)
wms4必须布尔新图层的默认值(请参阅设置)
wms5必须布尔新图层的默认值(请参阅设置)
wms6必须布尔新图层的默认值(请参阅设置)
wms7必须布尔新图层的默认值(请参阅设置)
wms8必须布尔新图层的默认值(请参阅设置)
wms9必须布尔新图层的默认值(请参阅设置)
wms10必须布尔新图层的默认值(请参阅设置)
列表标记可选布尔新图层的默认值(请参阅设置) 在图层地图下方显示标记列表的选项
multi_layer_map可选布尔0
multi_layer_map_list可选字符串(逗号分隔的层ID或全部) 例如1,2,3,4或全部
地址可选绳子 如果使用参数地址解析将被覆盖!
delete_markers可选真假false 当用于删除操作时,也会删除分配的标记
集群可选布尔新图层的默认值(请参阅设置) 仅在专业版中可用
gpx_url可选绳子 从v1.2p开始
gpx_panel可选布尔0 从v1.2p开始


标记列表操作的特殊参数

产品型号需要?数据类型说明
订单密钥可选绳子允许的排序顺序值:id,createdon,updatedon,kml_timestamp,markername,底图,lat,lon,createdby,updatedby,address
订单目录可选绳子允许的排序方向值:ASC,DESC
订购可选整数标记列表的偏移
限价单可选整数标记列表的限制
回到顶部


图层列表动作的特殊参数

产品型号需要?数据类型说明
订单密钥可选绳子允许的排序顺序值:id,updatedon,createdon,名称,底图,layerviewlat,layerviewlon,createdby,updatedby,地址
订单目录可选绳子允许的排序方向值:ASC,DESC
订购可选整数图层列表的偏移
限价单可选整数图层列表的限制
回到顶部


搜索动作的特殊参数

产品型号需要?数据类型说明
搜索键必须绳子允许的搜索键:id,markername,底图,图层,lat,lon,icon,popuptext,zoom,openpopup,mapwidth,mapwidthunit,mapheight,panel,createdby,createdon,updatedby,updatedon,controlbox,overlays_custom,overlays_custom2,overlays_custom3,overlays_custom4,wms ,wms2,wms3,wms4,wms5,wms6,wms7,wms8,wms9,wms10,kml_timestamp,地址,gpx_url,gpx_panel,名称,layerzoom,layerviewlat,layerviewlon,listmarkers,multi_layer_map,multi_layer_map_list,聚类,boundingbox
搜索值依靠字符串或整数通常是必需的,但在使用在,更新或边界框上创建的搜索键时是可选的
date_from依靠字符串(Ymd H:i:s)通常是可选的,但在使用创建时或更新时使用搜索键时是必需的
date_to依靠字符串(Ymd H:i:s)通常是可选的,但在使用创建时或更新时使用搜索键时是必需的
lat_top_left依靠floatval(6)通常是可选的,但在使用搜索键边界框时是必需的
lon_top_left依靠floatval(6)通常是可选的,但在使用搜索键边界框时是必需的
lat_bottom_right依靠floatval(6)通常是可选的,但在使用搜索键边界框时是必需的
lon_bottom_right依靠floatval(6)通常是可选的,但在使用搜索键边界框时是必需的
回到顶部