A plugin to talk to Citizen Space via its API.
| Author: | Delib (profile at wordpress.org) |
| WordPress version required: | 3.3.1 |
| WordPress version tested: | 3.5.2 |
| Plugin version: | 1.1 |
| Added to WordPress repository: | 02-05-2012 |
| Last updated: | 19-07-2013
Warning! This plugin has not been updated in over 2 years. It may no longer be maintained or supported and may have compatibility issues when used with more recent versions of WordPress.
|
| Rating, %: | 0 |
| Rated by: | 0 |
| Plugin URI: | |
| Total downloads: | 331 |
 Click to start download |
|
This plugin is designed to be used with any Citizen Space site running Citizen Space version 1.6.5 or greater. This may be:
- A Citizen Space site that you or your organisation administers.
- A Citizen Space site that you don't administer, but which contains interesting content you'd like to syndicate on your own site.
With this plugin, you can use shortcodes to embed parts of the Citizen Space frontend into your own pages and posts. The following shortcodes are supported:
- [citizenspace_basic_search] - The short 'Find consultations' keyword search form.
- [citizenspace_advanced_search] - The Advanced consultation search form.
- [citizenspace_search_results] - A list of consultations matching a predefined search, or based on the on the form fields above.
- [citizenspace_consultation url="http://full_consultation_url"] - An individual consultation record.
To use a shortcode, simply copy and paste the code (including its square brackets) into any page or post. When the page or post is displayed, WordPress will contact the Citizen Space site, request the appropriate information and seamlessly display it in place of the shortcode.
Example
To turn a page in your WordPress site into a fully-functional consultation search page, just copy and paste the following three lines:
[citizenspace_advanced_search]
Search results:
[citizenspace_search_results]
Shortcode builder
If you want to include a list of consultations based on a predefined search (rather than allowing the visitor to choose their search parameters using the form) you can pass an additional query parameter to the [citizenspace_search_results] shortcode, so it looks something like:
[citizenspace_search_results query="hide_batch_nav=1&st=open&au=Community+groups&ar=.site.Horfield&b_size=0"]
Obviously a query like this is fiddly to write by hand, so there's tool in the WordPress backend under Tools->Citizen Space to make this simpler. Just enter your search details like you would do on Citizen Space's consultation search page, and it will generate a shortcode for you. You can then embed this code in your page or post and you'll get an up-to-the-minute listing of all consultations matching your query.
Link options
By default, the consultations in the search results link directly to the consultation overview on the Citizen Space site. If you would prefer to embed the overview pages in your own site, so that visitors don't have to leave your site to read them, you can change this in Settings->Citizen Space.