注意: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の一般的なコア機能の一部にアクセスできる将来性のある方法を開発者に提供します。

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

パラメーター

収益

  • $ result 混合

    マーカーID(int)または WP_Error インスタンス。

使用例


$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。

収益

  • $ result 混合

    マーカーが正常に削除された場合は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。

収益

  • $ result 混合

    マーカーオブジェクトまたはFalse。

使用例

$result = MMPAPI::get_marker( 5 );
トップに戻ります


get_markers

指定されたマーカーIDのマーカーオブジェクトを返します。

public static function get_markers( $marker_ids ) {}

パラメーター

  • $ marker_ids 配列

    マーカーのID。

収益

  • $ result 混合

    マーカーオブジェクトまたはFalse。

使用例

$result = MMPAPI::get_markers( array( 1, 5, 10 ) );
トップに戻ります


list_markers

すべてのマーカーオブジェクトを返します。

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

パラメーター

収益

  • $ result 混合

    マーカーオブジェクトまたはFalse。

使用例


$args['orderkey'] = 'markername';
$args['orderdir'] = 'ASC';
$result = MMPAPI::list_markers( $args );
トップに戻ります


search_markers

指定された引数のマーカーオブジェクトを検索します。

public static function search_markers( $args ) {}

パラメーター

収益

  • $ result 混合

    パラメータに一致するマーカーオブジェクトまたはFalse。

使用例


$args['searchkey'] = 'layer';
$args['searchvalue'] = 7;
$result = MMPAPI::search_markers( $args );
トップに戻ります


update_marker

指定されたデータオブジェクトに基づいてマーカーを更新します

public static function update_marker( $marker_data ) {}

パラメーター

収益

  • $ result ブール値

    マーカーが更新されている場合は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 ) {}

パラメーター

収益

  • $ result 混合

    更新されたマーカーまたはエラーオブジェクトの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 ) {}

パラメーター

収益

  • $ result 混合

    レイヤーID(int)または WP_Error インスタンス。

使用例


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

パラメーター

収益

  • $ layers 混合

    レイヤー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です。

収益

  • $ result 混合

    レイヤーが正常に削除された場合は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。

収益

  • $ result 混合

    レイヤーオブジェクトまたはFalse。

使用例

$result = MMPAPI::get_layer( 5 );
トップに戻ります


get_layers

指定されたレイヤーIDのレイヤーオブジェクトを返します。

public static function get_layers( $layer_ids ) {}

パラメーター

  • $ layer_ids 配列

    レイヤーのID。

収益

  • $ result 混合

    レイヤーオブジェクトまたはFalse。

使用例

$result = MMPAPI::get_layers( array( 1, 5, 10 ) );
トップに戻ります


list_layers

すべてのレイヤーオブジェクトを返します。

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

パラメーター

収益

  • $ result 混合

    レイヤーオブジェクトまたはFalse。

使用例


$args['orderkey'] = 'name';
$args['orderdir'] = 'ASC';
$result = MMPAPI::list_layers( $args );
トップに戻ります


search_layers

与えられた引数についてレイヤオブジェクトを検索します。

public static function search_layers( $args ) {}

パラメーター

収益

  • $ result 混合

    パラメータまたはFalseに一致するレイヤーオブジェクト。

使用例


$args['searchkey'] = 'name';
$args['searchvalue'] = 'Washington';
$result = MMPAPI::search_layers( $args );
トップに戻ります


update_layer

指定されたデータオブジェクトに基づいてレイヤーを更新します

public static function update_layer( $layer_data ) {}

パラメーター

収益

  • $ result ブール値

    レイヤーが更新されている場合は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 ) {}

パラメーター

収益

  • $ result 混合

    更新されたレイヤーまたはエラーオブジェクトの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 ) {}

パラメーター

  • $ capabilities 混合

    XNUMXつの機能のみ、または複数の配列をチェックする場合は文字列 機能

収益

  • $ result 混合

    マーカーID(int)または WP_Error インスタンス。

使用例


$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を上書きします
ベースマップ 任意 事前定義されたベースマップID-注を参照 新しいマーカーのデフォルトのベースマップ(設定を参照) osm_mapnik、mapquest_osm、mapquest_aerial、googleLayer_roadmap、googleLayer_satellite、googleLayer_hybrid、googleLayer_terrain、bingaerial、bingaerialwithlabels、bingroad、ogdwien_basemap、ogdwien_satelbase、map_base_basebase2 mapmap、base_map_base3、mapbox、map_base2、mapbox、map_base3、mapbox、mapXNUMX
任意 整数 新しいマーカーのデフォルトレイヤー(設定を参照)
ラット任意フロート新しいマーカーのデフォルトの場所(設定を参照) パラメータジオコードを使用すると上書きされます!
LON任意フロート新しいマーカーのデフォルトの場所(設定を参照) パラメータジオコードを使用すると上書きされます!
アイコン任意文字列(例:bus.png)NULL NULLの場合、デフォルトのアイコンが使用されます。 例に示されているように、アイコンのファイル名を使用してください。 アイコンディレクトリで使用可能なすべてのアイコン(通常、/ wp-content / uploads / leaflet-maps-marker-icons(設定/マップのデフォルト/マーカーアイコンのデフォルト値で変更しなかった場合))を使用できます。
ポップアップテキスト任意文字列NULL
ズーム任意整数新しいマーカーのデフォルトのズーム(設定を参照)
openpopup任意ブール値新しいマーカーのデフォルト値(設定を参照)
マップ幅任意整数新しいマーカーのデフォルトのマップ幅(設定を参照)
mapwidthunit任意文字列新しいマーカーのデフォルト値(設定を参照)
mapheight任意整数新しいマーカーのデフォルトのmapheight(設定を参照)
パネル任意ブール値新しいマーカーのデフォルト値(設定を参照)
によって作成された任意文字列NULL
作成した任意日付(Ymd H:i:s)NULL
更新者任意文字列NULL
更新された任意日付(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)NULL
住所任意文字列NULL パラメータジオコードを使用すると上書きされます!
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_satelbase、map_base_basebase2 mapmap、base_map_base3、mapbox、map_base2、mapbox、map_base3、mapbox、mapXNUMX
レイヤーズーム任意整数新しいレイヤーのデフォルトのズーム(設定を参照)
mapwidthunit任意文字列新しいレイヤーのデフォルト値(設定を参照)
マップ幅任意整数新しいレイヤーのデフォルトのマップ幅(設定を参照)
mapheight任意整数新しいレイヤーのデフォルトのmapheight(設定を参照)
パネル任意ブール値新しいレイヤーのデフォルト値(設定を参照)
レイヤービュー任意フロート新しいレイヤーのデフォルトの緯度(設定を参照) パラメータジオコードを使用すると上書きされます!
レイヤービューロン任意フロート新しいレイヤーのデフォルトlon(設定を参照) パラメータジオコードを使用すると上書きされます!
によって作成された任意文字列NULL
作成した任意日付(Ymd H:i:s)NULL
更新者任意文字列NULL
更新された任意日付(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またはすべて)NULL 例:1,2,3,4、XNUMX、XNUMX、XNUMXまたはすべて
住所任意文字列NULL パラメータジオコードを使用すると上書きされます!
delete_markers任意真/偽false 削除アクションで使用すると、割り当てられたマーカーも削除されます
クラスタリング任意ブール値新しいレイヤーのデフォルト値(設定を参照) プロバージョンでのみ利用可能
gpx_url任意文字列NULL v1.2p以降
gpx_panel任意ブール値0 v1.2p以降


マーカーリストアクションの特別なパラメーター

パラメーター必須?データ・タイプノート
注文キー任意文字列許可されたソート順の値:id、createdon、updatedon、kml_timestamp、markername、basemap、lat、lon、createdby、updatedby、address
orderdir任意文字列許可されているソート方向の値:ASC、DESC
注文任意整数マーカーリストのオフセット
注文制限任意整数マーカーリストの制限
トップに戻ります


レイヤーリストアクションの特別なパラメーター

パラメーター必須?データ・タイプノート
注文キー任意文字列許可されたソート順の値:id、updatedon、createdon、name、basemap、layerviewlat、layerviewlon、createdby、updatedby、address
orderdir任意文字列許可されているソート方向の値:ASC、DESC
注文任意整数レイヤーリストのオフセット
注文制限任意整数レイヤーリストの制限
トップに戻ります


検索アクションの特別なパラメーター

パラメーター必須?データ・タイプノート
searchkey必須文字列使用できる検索キー:id、markername、basemap、layer、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、address、gpx_url、gpx_panel、name、layerzoom、layerviewlat、layerviewlon、listmarkers、multi_layer_map、multi_layer_map_list、clustering、boundingbox
searchvalue依存文字列または整数一般に必須ですが、createdon、updatedon、またはboundingboxを使用する場合はオプションです。
デートから依存文字列(Ymd H:i:s)通常はオプションですが、createdonまたはupdatedonを使用する場合は必須です
date_to依存文字列(Ymd H:i:s)通常はオプションですが、createdonまたはupdatedonを使用する場合は必須です
lat_top_left依存floatval(6)通常はオプションですが、searchkey boundingboxを使用する場合は必須です
lon_top_left依存floatval(6)通常はオプションですが、searchkey boundingboxを使用する場合は必須です
lat_bottom_right依存floatval(6)通常はオプションですが、searchkey boundingboxを使用する場合は必須です
lon_bottom_right依存floatval(6)通常はオプションですが、searchkey boundingboxを使用する場合は必須です
トップに戻ります