Внимание: 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
  4. Слои
    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. Разрешения
    1. current_user_can_any
  6. параметры
    1. Доступные параметры для типа маркера
    2. Доступные параметры для типа слоя
    3. Специальные параметры для действия со списком маркеров
    4. Специальные параметры для действия со списком слоев
    5. Специальные параметры для поисковых действий


Введение

Функции API Maps Marker Pro предоставляют разработчикам перспективный способ получить доступ к некоторым основным функциональным возможностям в Maps Marker Pro.

Функции API автоматически включаются при загрузке Maps Marker Pro и будут доступны к моменту загрузки надстроек. Класс 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 ) {}

параметры

Условия возврата товара

  • $ маркеры смешанный

    Массив идентификаторов маркеров или объекта 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

Удаляет маркер с указанным идентификатором маркера.

public static function delete_marker( $marker_id ) {}

параметры

  • $ marker_id целое

    Идентификатор маркера, который нужно удалить.

Условия возврата товара

Пример использования

$result = MMPAPI::delete_marker( $marker_id );
вернуться к началу


delete_markers

Удаляет маркеры для заданных идентификаторов маркеров.

public static function delete_markers( $marker_ids ) {}

параметры

  • $ marker_ids массив

    Идентификаторы маркеров.

Условия возврата товара

  • $ результат смешанный

    True, если маркеры успешно удалены, WP_Error возражать если нет.

Пример использования


$marker_ids = array(6,7,8);
$result = MMPAPI::delete_markers( $marker_ids );
вернуться к началу


get_marker

Возвращает объект маркера для данного идентификатора маркера.

public static function get_marker( $marker_id ) {}

параметры

  • $ marker_id целое

    Идентификатор маркера.

Условия возврата товара

  • $ результат смешанный

    Маркерный объект или Ложь.

Пример использования

$result = MMPAPI::get_marker( 5 );
вернуться к началу


get_markers

Возвращает объекты маркеров для заданных идентификаторов маркеров.

public static function get_markers( $marker_ids ) {}

параметры

  • $ marker_ids массив

    Идентификаторы маркеров.

Условия возврата товара

  • $ результат смешанный

    Маркерные объекты или Ложь.

Пример использования

$result = MMPAPI::get_markers( array( 1, 5, 10 ) );
вернуться к началу


list_markers

Возвращает все объекты маркера.

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

параметры

Условия возврата товара

  • $ результат смешанный

    Маркерные объекты или Ложь.

Пример использования


$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 ) {}

параметры

Условия возврата товара

  • $ результат смешанный

    Массив идентификаторов обновленных маркеров или объекта ошибки.

Пример использования


$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 ) {}

параметры

Условия возврата товара

  • $ слои смешанный

    Массив идентификаторов слоев или объект 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

Удаляет слой с указанным идентификатором слоя.

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

параметры

  • $ layer_id целое

    Идентификатор слоя, который нужно удалить.

  • $ delete_markers логический

    Логический параметр, если он имеет значение TRUE, метод удалит все маркеры, связанные со слоем. Значением по умолчанию является ЛОЖЬ.

Условия возврата товара

Пример использования

$result = MMPAPI::delete_layer( $layer_id );
вернуться к началу


delete_layers

Удаляет слои для заданных идентификаторов слоев

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

параметры

  • $ layers_ids массив

    Идентификаторы слоев.

  • $ delete_markers логический

    Логический параметр, если он имеет значение TRUE, метод удалит все маркеры, связанные со слоями. Значением по умолчанию является ЛОЖЬ.

Условия возврата товара

  • $ результат смешанный

    Истинно, если слои успешно удалены, WP_Error возражать если нет.

Пример использования


$layers_ids = array(6,7,8);
$result = MMPAPI::delete_layers( $layers_ids );
вернуться к началу


get_layer

Возвращает объект слоя для данного идентификатора слоя.

public static function get_layer( $layer_id ) {}

параметры

  • $ layer_id целое

    Идентификатор слоя.

Условия возврата товара

Пример использования

$result = MMPAPI::get_layer( 5 );
вернуться к началу


get_layers

Возвращает объекты слоя для заданных идентификаторов слоя.

public static function get_layers( $layer_ids ) {}

параметры

  • $ layer_ids массив

    Идентификаторы слоев.

Условия возврата товара

Пример использования

$result = MMPAPI::get_layers( array( 1, 5, 10 ) );
вернуться к началу


list_layers

Возвращает все объекты слоя.

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

параметры

Условия возврата товара

Пример использования


$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 ) {}

параметры

Условия возврата товара

  • $ результат смешанный

    Массив идентификаторов обновленных слоев или объекта ошибки.

Пример использования


// 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обязательныйцелоеустанавливается автоматически при добавлении нового маркера
маркернеобязательныйстрокаNULL,
геокоднеобязательныйстрокаNULL, значение получает геокодирование через 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, mapbox2, mapbox3, custom_basemap, custom_basemap2, custom_basemap3, empty_basemap
слой необязательный целое слой по умолчанию для нового маркера (см. настройки)
латнеобязательныйплаватьместоположение по умолчанию для нового маркера (см. настройки) перезаписывается, если используется параметр geocode!
долготанеобязательныйплаватьместоположение по умолчанию для нового маркера (см. настройки) перезаписывается, если используется параметр geocode!
значокнеобязательныйстрока (например, bus.png)NULL, если NULL, будет использоваться значок по умолчанию. Пожалуйста, просто используйте имя файла иконки, как указано в примере. Все значки, доступные в каталоге значков (обычно это / wp-content / uploads / leaflet-maps-marker-icons, если вы не меняли его в настройках / по умолчанию для карт / значения по умолчанию для значков маркеров), доступны для использования.
всплывающий текстнеобязательныйстрокаNULL,
зумнеобязательныйцелоемасштаб по умолчанию для нового маркера (см. настройки)
openpopupнеобязательныйлогическийзначение по умолчанию для новых маркеров (см. настройки)
ширина картынеобязательныйцелоеКарта по умолчанию для новых маркеров (см. настройки)
mapwidthunitнеобязательныйстроказначение по умолчанию для новых маркеров (см. настройки)
mapheightнеобязательныйцелоевысота карты по умолчанию для новых маркеров (см. настройки)
панельнеобязательныйлогическийзначение по умолчанию для новых маркеров (см. настройки)
созданнеобязательныйстрокаNULL,
создано нанеобязательныйдатаNULL,
UpdatedByнеобязательныйстрокаNULL,
обновлениенеобязательныйдатадата ('Ymd H: i: s)
блок управлениянеобязательныйлогическийзначение по умолчанию для новых маркеров (см. настройки)
overlays_customнеобязательныйлогическийзначение по умолчанию для новых маркеров (см. настройки)
overlays_custom2необязательныйлогическийзначение по умолчанию для новых маркеров (см. настройки)
overlays_custom3необязательныйлогическийзначение по умолчанию для новых маркеров (см. настройки)
overlays_custom4необязательныйлогическийзначение по умолчанию для новых маркеров (см. настройки)
WMSнеобязательныйлогическийзначение по умолчанию для новых маркеров (см. настройки)
wms2необязательныйлогическийзначение по умолчанию для новых маркеров (см. настройки)
wms3необязательныйлогическийзначение по умолчанию для новых маркеров (см. настройки)
wms4необязательныйлогическийзначение по умолчанию для новых маркеров (см. настройки)
wms5необязательныйлогическийзначение по умолчанию для новых маркеров (см. настройки)
wms6необязательныйлогическийзначение по умолчанию для новых маркеров (см. настройки)
wms7необязательныйлогическийзначение по умолчанию для новых маркеров (см. настройки)
wms8необязательныйлогическийзначение по умолчанию для новых маркеров (см. настройки)
wms9необязательныйлогическийзначение по умолчанию для новых маркеров (см. настройки)
wms10необязательныйлогическийзначение по умолчанию для новых маркеров (см. настройки)
kml_timestampнеобязательныйдатаNULL,
адреснеобязательныйстрокаNULL, перезаписывается, если используется параметр geocode!
gpx_urlнеобязательныйстрокаNULL, начиная с v1.2p
gpx_panelнеобязательныйлогический0 начиная с v1.2p

вернуться к началу


Доступные параметры для типа слоя

Параметр Необходимые? Тип данных Значение по умолчанию Примечания
idобязательныйцелоеустанавливается автоматически при добавлении нового маркера
геокоднеобязательныйстрокаNULL, значение получает геокодирование через Google Places API и перезаписывает параметр lat, lon и address
имянеобязательныйстрокаNULL,
Базовая картанеобязательныйпредопределенные значениябазовая карта по умолчанию для нового слоя (см. настройки) osm_mapnik, mapquest_osm, mapquest_aerial, googleLayer_roadmap, googleLayer_satellite, googleLayer_hybrid, googleLayer_terrain, bingaerial, bingaerialwithlabels, bingroad, ogdwien_basemap, ogdwien_satellite, MapBox, mapbox2, mapbox3, custom_basemap, custom_basemap2, custom_basemap3, empty_basemap
Layerzoomнеобязательныйцелоемасштаб по умолчанию для нового слоя (см. настройки)
mapwidthunitнеобязательныйстроказначение по умолчанию для нового слоя (см. настройки)
ширина картынеобязательныйцелоеКарта по умолчанию для нового слоя (см. настройки)
mapheightнеобязательныйцелоевысота карты по умолчанию для нового слоя (см. настройки)
панельнеобязательныйлогическийзначение по умолчанию для нового слоя (см. настройки)
слойнеобязательныйплаватьлат по умолчанию для нового слоя (см. настройки) перезаписывается, если используется параметр geocode!
слойнеобязательныйплаватьlon по умолчанию для нового слоя (см. настройки) перезаписывается, если используется параметр geocode!
созданнеобязательныйстрокаNULL,
создано нанеобязательныйдатаNULL,
UpdatedByнеобязательныйстрокаNULL,
обновлениенеобязательныйдатадата ('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необязательныйстрока (разделенные запятыми идентификаторы слоя или все)NULL, например, 1,2,3,4 или все
адреснеобязательныйстрокаNULL, перезаписывается, если используется параметр geocode!
delete_markersнеобязательныйистина / ложьложный при использовании действия удаления удаляются также назначенные маркеры
кластеризациинеобязательныйлогическийзначение по умолчанию для нового слоя (см. настройки) доступно только в профессиональной версии
gpx_urlнеобязательныйстрокаNULL, начиная с v1.2p
gpx_panelнеобязательныйлогический0 начиная с v1.2p


Специальные параметры для действия со списком маркеров

ПараметрНеобходимые?Тип данныхПримечания
ключ заказанеобязательныйстрокаДопустимые значения порядка сортировки: идентификатор, созданный, обновленный, kml_timestamp, имя маркера, базовая карта, широта, долгота, созданный, обновленный, адрес
orderdirнеобязательныйстрокаДопустимые значения направления сортировки: ASC, DESC
приказнеобязательныйцелоеСмещение для списка маркеров
предел заказанеобязательныйцелоеПредел для списка маркеров
вернуться к началу


Специальные параметры для действия со списком слоев

ПараметрНеобходимые?Тип данныхПримечания
ключ заказанеобязательныйстрокаДопустимые значения порядка сортировки: идентификатор, обновленный, созданный, имя, базовая карта, layerviewlat, layerviewlon, созданный by, updatedby, адрес
orderdirнеобязательныйстрокаДопустимые значения направления сортировки: ASC, DESC
приказнеобязательныйцелоеСмещение для списка слоев
предел заказанеобязательныйцелоеПредел для списка слоев
вернуться к началу


Специальные параметры для поисковых действий

ПараметрНеобходимые?Тип данныхПримечания
ключ поискаобязательныйстрокаРазрешенные поисковые ключи: id, имя маркера, базовая карта, слой, широта, долгота, значок, всплывающий текст, масштабирование, openpopup, mapwidth, mapwidthunit, высота карты, панель, созданная, создана, обновлена, обновлена, панель управления, 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, кластеризация, кластеризация
значение поисказависитстрока или целое числообычно требуется, но необязательно при использовании ключа поиска, созданного, обновленного или ограничивающего окна
Дата, сзависитстрока (Ymd H: i: s)как правило, необязательно, но требуется при использовании ключа поиска, созданного или обновленного
date_toзависитстрока (Ymd H: i: s)как правило, необязательно, но требуется при использовании ключа поиска, созданного или обновленного
lat_top_leftзависитfloatval (6)как правило, необязательно, но требуется при использовании поискового ключа boundingbox
lon_top_leftзависитfloatval (6)как правило, необязательно, но требуется при использовании поискового ключа boundingbox
lat_bottom_rightзависитfloatval (6)как правило, необязательно, но требуется при использовании поискового ключа boundingbox
lon_bottom_rightзависитfloatval (6)как правило, необязательно, но требуется при использовании поискового ключа boundingbox
вернуться к началу