內容目錄
內容簡介
這個外掛允許您在 WordPress 網站的側邊欄中以地圖小工具顯示您的最新 Swarm 簽到，或透過短碼嵌入文章或頁面中。
設置和選項包括以下內容：
1. 使用 OAuth 2.0 將您的 WordPress 網站與 Foursquare 帳戶關聯，以保持您的個人資訊安全。
2. 選擇要在哪個地圖供應商上顯示您的簽到；您可以從以下選擇：
- HERE Maps
- Google Maps v3
- Bing Maps v7
- 使用 Leaflet 的 OpenStreetMap
- 使用 OpenLayers 的 OpenStreetMap
- 使用 MapQuest 的 OpenStreetMap
3. 添加所選地圖供應商的地圖 API 金鑰；HERE、Google、Bing 和 MapQuest 地圖都需要 API 金鑰。
4. 選擇側邊欄上小工具和地圖的寬度和高度。寬度和高度可以指定為像素 (px) 或百分比。
5. 選擇地圖顯示的縮放級別。
經由外掛的篩選器，可以自訂包含場所名稱、場所 URL 和您最後 Swarm 簽到的時間戳記的副標題文字。
此外掛的當前版本允許您將單個 Foursquare 帳戶與 WordPress 網站相關聯；目前不支援將多個 Foursquare 帳戶（每個使用者帳戶一個）相關聯。
短碼支援和使用方式：
WP Quadratum 支援兩個短碼和三個短碼別名；使用 [wp_quadratum_map] 短碼將其展開插入文章或頁面中，並替換簽到地圖，透過 [wp_quadratum_locality] 短碼，您可以在文章或頁面中嵌入最後一次簽到的某些方面。
[wp_quadratum_map] 短碼支援多個屬性，使您可以自訂短碼如何展開為簽到地圖：
- 寬度屬性 (width)
- 寬度單位屬性 (width_units)
- 高度屬性 (height)
- 高度單位屬性 (height_units)
- 縮放屬性 (zoom)
"寬度" 屬性與 "高度" 屬性相結合，可指定要插入到文章或頁面中的地圖的寬度。如果未指定，地圖寬度將預設為 300。
"寬度單位" 屬性，指定如何解釋 "寬度" 屬性中指定的值。這個屬性的有效值為 "px" 和 "%"，分別表示 "寬度" 屬性應該以像素或百分比來解釋。如果未指定此屬性，它的預設值為 "px"。
"高度" 屬性表示地圖將插入到文章或頁面中時的高度。如果未指定，地圖的高度將預設為 300。
外掛標籤
開發者團隊
原文外掛簡介
This plugin allows you to display your last Swarm checkin as a map widget on the sidebar or embedded via a shortcode in a post or page of your WordPress powered site.
Setting and options include:
Associate your WordPress powered site with your Foursquare account using OAuth 2.0, which keeps your personal information safe and secure.
Choose which map provider you want your checkin shown on; you can choose from:
HERE Maps
Google Maps v3
Bing Maps v7
OpenStreetMap from Leaflet
OpenStreetMap from OpenLayers
OpenStreetMap from MapQuest
Add your maps API key(s) for your chosen map provider; HERE, Google, Bing and MapQuest maps all require API keys.
Choose the width and height of the widget and map on the sidebar. The width and height can be specified either as pixels (px) or as a percentage.
Choose the zoom level of the map display.
The strapline text containing the venue name, venue URL and timestamp of your last Swarm checkin can be customised via the plugin’s filters. See the Filter Support And Usage section for more information.
The current version of this plugin allows you to associate a single Foursquare account with your WordPress site; associating multiple Foursquare accounts, one per user account is not currently supported.
Shortcode Support And Usage
WP Quadratum supports two shortcodes and three shortcode aliases; [wp_quadratum_map] to expand the shortcode in a post or page and replace it with the checkin map and [wp_quadratum_locality] to allow you to embed aspects of your last checkin in a post or page.
[wp_quadratum_map]
Adding this shortcode to the content of a post or page 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 width_units attribute
the height attribute
the height_units attribute
the zoom attribute
** The “width” Attribute **
The width attribute, in conjunction with the height attribute specifies the width of the map to be inserted into a post or page. If omitted, the map width defaults to a value of 300.
** The “width_units” Attribute **
The width_units attribute, specifies how the value specified in the width attribute should be interpreted. Valid values for this attribute as px and %, denoting that the width attribute should be interpreted in pixels or as a percentage respectively. If omitted, this attribute defaults to a value of px.
** The “height” Attribute **
The height attribute, in conjunction with the width attribute specifies the height of the map to be inserted into a post or page. If omitted, the map height defaults to a value of 300.
** The “height_units” Attribute **
The height_units attribute, specifies how the value specified in the height attribute should be interpreted. Valid values for this attribute as px and %, denoting that the height attribute should be interpreted in pixels or as a percentage respectively. If omitted, this attribute defaults to a value of px.
** 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.
[wp_quadratum]
The [wp_quadratum] shortcode is an alias for the [wp_quadratum_map] shortcode and has the same functionality.
[wpq_map]
The [wpq_map] shortcode is an alias for the [wp_quadratum_map] shortcode and has the same functionality.
[wp_quadratum_locality]
Adding this shortcode to the content of a post or page, expands the shortcode and replaces it with information about your last Foursquare checkin. The information to be displayed is selected by the shortcode’s type attribute, which allows you to select the venue name, address, region, postal code, coordinates, timezone or timezone offset.
By default, the [wp_quadratum_locality] shortcode and the [wpq_locality] alias are disabled. This is because not all Foursquare venues contain the full scope of locality elements that the shortcode supports (the minimum requirements for a Foursquare venue are name, category and coordinates). To backfill any missing venue elements, WP Quadratum uses a reverse geocoding service from Factual to supply the missing information.
To enable the [wp_quadratum_locality] shortcode, from the Dashboard navigate to Settings / WP Quadratum and click on the Shortcodes tab. Select the Enable Locality Shortcode Usage checkbox and the Factual OAuth Settings meta-box will appear. You’ll then need to sign up for a Factual API key after which you’ll be given an OAuth Key and OAuth Secret. Copy and paste these into the Factual OAuth text fields and click on Save Shortcode Settings. You’ll now be able to use the [wp_quadratum_locality] shortcode or its alias.
The “type” Attribute
The type attribute specifies the element of your last Foursquare checkin that is to be displayed in a post or page and can take one of the following values:
venue – the name of the last Foursquare venue you checked into.
address – the street address of the venue; not including the region, locality or postal code.
region – the region of the venue; the geographic context of the region will vary from country to country but is roughly analogous to the venue’s city.
postcode – the postal code of the venue, if the country or region supports postal codes.
coordinates – the geographic coordinates of the venue, in the form latitude,longitude.
timezone – the timezone name of the time of the checkin, such as Europe/London.
tzoffset – the offset from GMT of the time of the checkin, in the form GMT[-+]hours, such as GMT-1 or GMT+2.
locality – the locality of the venue; the geographic context of the locality will vary according to country, but is roughly analogous to the town or neighbourhood.
If the type attribute is not supplied, or if the value of this attribute is not one of the above values, type="locality" will be assumed. The shortcode’s replacement value can be modified via the plugin’s wp_quadratum_locality filter; see the Filter Support and Usage section for more information.
[wpq_locality]
The [wpq_locality] shortcode is an alias for the [wp_quadratum_locality] shortcode and has the same functionality.
Filter Support And Usage
WP Quadratum supports three filters, which are described in more detail below. The plugin’s filters allow you to:
change the descriptive text that appears immediately below the map when displayed via the plugin’s widget or shortcode.
gain access to the checkin metadata that is returned from the Foursquare API
change the output of the [wp_quadratum_locality]` shortcode
wp_quadratum_checkin
Allow a filter hook function to gain access to the checkin metadata that is returned from the Foursquare API and which is used to build the checkin map and strapline. It’s important to note that the implementation of this filter isn’t strictly a WordPress filter per se. The user defined hook function is passed only the checkin metadata. Any changes made to the metadata will not be reflected in the output of the plugin’s or shortcode’s map, nor will any return value from the hook function be honoured by the plugin. The filter will be called before the wp_quadratum_strapline filter, if used, allowing you to store the checkin contents and use them within the wp_quadratum_strapline filter hook.
The contents of the checkin data this filter can access are a Checkin Response object, which is documented on the Foursquare Developer Site.
Example: Store the contents of the Foursquare checkin that the plugin will be to display the checkin map.
$last_checkin = null;
add_filter('wp_quadratum_checkin', store_last_checkin, 10, 1);
function store_last_checkin($checkin) {
$last_checkin = $checkin;
}
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 = '
Last seen at ' . $params['venue-name'] . ' on ' . date('l jS \of F Y h:i:s A', $params['checked-in-at']) . '
';
return $strapline;
}
wp_quadratum_locality
Applied to the replacement content of the [wp_quadratum_locality] shortcode immediately before the shortcode is replaced. The filter’s hook function is passed two arguments; the shortcode’s value and corresponding type attribute.
Example: Wrap each invocation of the [wp_quadratum_locality] shortcode in a div whose class includes the attribute type.
add_filter('wp_quadratum_locality', 'format_locality', 10, 2);
function format_locality($value, $type) {
$class = 'wp-quadratum-locality-' . $type;
return '
';
}
