WordPress.org

Shortcode Support And Usage

WP Quadratum supports a single shortcode, [wp_quadratum]. Adding this shortcode to the content of a post or page or into a theme template as content, expands the shortcode and replaces it with a checkin map.

The shortcode also supports multiple attributes which allow you to customise the way in which the shortcode is expanded into the checkin map:

• the width attribute
• the height attribute
• the zoom attribute

The "width" Attribute

The width attribute, in conjunction with the height attribute specifies the width, in pixels, of the map to be inserted into a post or page. If omitted, the map width defaults to a value of 300px.

The "height" Attribute

The height attribute, in conjunction with the width attribute specifies the height, in pixels, of the map to be inserted into a post or page. If omitted, the map height defaults to a value of 300px.

The "zoom" Attribute

The zoom attribute specifies the zoom level to be used when displaying the checkin map. If omitted, the zoom level defaults to a value of 16 which is roughly analogous to a neighbourhood zoom.

Filter Support And Usage

WP Quadratum supports a single filter, which is described below.

wp_quadratum_strapline

Applied to the strapline that is displayed via the plugin's widget or shortcode. The strapline is the text that appears immediately below the checkin map.

Example: Change the date and time formatting in the strapline

add_filter ('wp_quadratum_strapline', 'format_strapline', 10, 2);
function format_strapline ($content, $params) {
    // $params = array (
    //      'venue-url' => '4Sq venue url for checkin',
    //      'venue-name' => 'checkin venue name',
    //      'checked-in-at' => 'timestamp of checkin'
    //  );
    
    $strapline = '<h5>Last seen at <a href="' . $params['venue-url'] . '" target="_blank">' . $params['venue-name'] . '</a> on ' . date ('l jS \of F Y h:i:s A', $params['checked-in-at']) . '</h5>';
    return $strapline;
}