Docs For Class MMPAPI

Class MMPAPI

Description

Maps Marker Plugin - MMPAPI

Located in /class-mmpapi.php (line 8)

Method Summary

static mixed add_layer (array $layer_data)

static array add_layers (array $layers_data)

static mixed add_marker (array $marker_data)

static array|WP_Error add_markers ( $markers_data, array $marker_data)

static int count_layers ()

static int count_markers ()

static bool current_user_can_any (array|string $capabilities)

static mixed delete_layer (int $layer_id)

static boolean delete_layers ([array $layer_ids = array()])

static mixed delete_marker (int $marker_id)

static boolean delete_markers ([array $marker_ids = array()])

static mixed get_layer (int $layer_id)

static mixed get_marker (int $marker_id)

static array search_layers (array $args)

static array search_markers (array $args)

static boolean update_layer (array $layer_data)

static array|WP_Error update_layers (array $layers_data)

static boolean update_marker (array $marker_data)

static array|WP_Error update_markers ( $markers_data, array $marker_data)

Methods

static method add_layer (line 348)

Add a layer based on given data array

return: int|WP_Error
since: 2.5
access: public

static mixed add_layer (array $layer_data)

array $layer_data: Data of the layer

static method add_layers (line 418)

Add layers based on given data object

return: int|WP_Error
since: 2.5
access: public

static array add_layers (array $layers_data)

array $layers_data: Data of the marker

static method add_marker (line 44)

Add a marker based on given data array

return: int|WP_Error
since: 2.5
access: public

static mixed add_marker (array $marker_data)

array $marker_data: Data of the marker

static method add_markers (line 125)

Add markers based on given data object

return: IDs of added markers or an error object.
since: 2.5
access: public

static array|WP_Error add_markers ( $markers_data, array $marker_data)

array $marker_data: Data of the marker
$markers_data

static method count_layers (line 652)

returns the number of layers available

return: The layers count
since: 2.5
access: public

static int count_layers ()

static method count_markers (line 636)

returns the number of markers available

return: The markers count
since: 2.5
access: public

static int count_markers ()

static method current_user_can_any (line 1074)

Checks the permissions for the current user. Returns true if the current user has any of the specified capabilities.

IMPORTANT: Call this before calling any of the other API Functions as permission checks are not performed at lower levels.

return: Returns true if the current user has any of the specified capabilities
since: 2.5
access: public

static bool current_user_can_any (array|string $capabilities)

array|string $capabilities: An array of capabilities, or a single capability

static method delete_layer (line 542)

Deletes the layer for a given layer ID

return: TRUE if the layer deleted successfully, WP_Error object if not
since: 2.5
access: public

static mixed delete_layer (int $layer_id)

int $layer_id: The ID of the layer

static method delete_layers (line 588)

Deletes the layers for a given Layers IDs

return: true if the markers deleted successfully, WP_Error object if not
since: 2.5
access: public

static boolean delete_layers ([array $layer_ids = array()])

array $layer_ids: The IDs of the Layers

static method delete_marker (line 264)

Deletes the marker for a given Marker ID

return: TRUE if the marker deleted successfully, WP_Error object if not
since: 2.5
access: public

static mixed delete_marker (int $marker_id)

int $marker_id: The ID of the Marker

static method delete_markers (line 293)

Deletes the markers for a given Markers IDs

return: true if the markers deleted successfully, WP_Error object if not
since: 2.5
access: public

static boolean delete_markers ([array $marker_ids = array()])

array $marker_ids: The IDs of the Markers

static method get_layer (line 325)

Returns the layer object for a given Layer ID

return: The layer object or false
since: 2.5
access: public

static mixed get_layer (int $layer_id)

int $layer_id: The ID of the Layer

static method get_marker (line 21)

Returns the marker object for a given Marker ID

return: The marker object or false
since: 2.5
access: public

static mixed get_marker (int $marker_id)

int $marker_id: The ID of the Marker

static method search_layers (line 765)

Search layers object for a given args.

return: The layer objects.
since: 2.5
access: public

static array search_layers (array $args)

array $args: The parameters of the search

static method search_markers (line 671)

Search markers object for a given args.

return: The marker object or false
since: 2.5
access: public

static array search_markers (array $args)

array $args: The parameters of the search

static method update_layer (line 444)

Update a layer based on given data object

since: 2.5
access: public

static boolean update_layer (array $layer_data)

array $layer_data: Data of the layer

static method update_layers (line 516)

Update layers based on given data object

return: IDs of updated layers or an error object.
since: 2.5
access: public

static array|WP_Error update_layers (array $layers_data)

array $layers_data: Data of the layers

static method update_marker (line 153)

Update a marker based on given data object

since: 2.5
access: public

static boolean update_marker (array $marker_data)

array $marker_data: Data of the marker

static method update_markers (line 238)

Add markers based on given data object

return: IDs of added markers or an error object.
since: 2.5
access: public

static array|WP_Error update_markers ( $markers_data, array $marker_data)

array $marker_data: Data of the marker
$markers_data

Documentation generated on Sun, 26 Jul 2015 07:58:59 -0500 by phpDocumentor 1.4.4