Skip to main content
  1. All Posts/


Tools Open Source PHP WordPress
=== Praized Tools ===
Contributors: stephdau, sylvaincarle
Tags: location, places, merchants, api, integration, widget, social, geocode, microformats, microformat
Requires at least: 2.2
Tested up to: 2.8
Stable tag: trunk

The Praized Tools plugin is primarily a companion tool for our
[Praized Community](
plugin. It will enable new editorial tools within your WordPress install
for you to blog about places, and tie everything back to your own Praized
Community. When running the Praized Tools without a Praized
Community, the plugin will integrate with our [ Hub](

== Description ==

The Praized Tools plugin will enable new editorial tools within your WordPress
install for you to blog about places and tie everything back to your or a 3rd
party's Praized community. It will also help you create your Praized sidebar

**NOTE**: The Praized Tools plugin **now comes pre-configured** with a read-only
API key that will link back to our [ Hub]( by default.

If you decide to also install our [Praized Community](
plugin, you can optionally set the Praized Tools plugin to use the same [API key](
you will acquire for your own community. If so, the Praized Tools will then link back
to your own site instead of our [ Hub]( These setting
can be changed at any time.

This plugin is designed for use with the latest version of WordPress, but will
work with versions 2.2 and newer. Our plugins also support WordPress MU 1.3+.

**See also**: The [Praized Community]( plugin (requires PHP5).

== Installation ==

###Upgrading From A Previous Version###

To upgrade from a previous version of this plugin, delete the entire folder and
files from the previous version of the plugin and then follow the installation
instructions below.

###Installing The Plugin###

Extract all files from the ZIP file, making sure to keep the file structure intact,
and then upload the plugin's folder to `/wp-content/plugins/`.

This should result in something very similiar to the following file structure:

`- wp-content
  - plugins
    - praized-tools
      | license.txt
      | praized-tools.php
      | readme.txt
      - includes
        - [ ... ]`

Then visit your admin area and activate the plugin and follow the onscreen

Once you have received your API access credentials, go to the plugin's
configuration screen in "Admin -> Settings -> Praized Tools" and fill in
the appropriate options with the information provided to you by Praized Media
when you [request access to our API]( 

**See Also:** ["Installing Plugins" on the WP Codex](

== Screenshots ==

1. Sample output: Embedded places, post/page level place aggregation (with microformats goodness), dynamic search results widget, etc.
2. Praized Searchlet: search tool to facilitate embedding places within your post and/or pages. We currently have 17+ million places for you to choose from (US and Canada). You can also add new places, just in case.
3. Samples of the shortcode/bbcode generated by the Praized Searchlet. You can embed single places, search results, etc. Also shows the Searchlet launcher (Praized logo button).
4. Praized widget: this widget allows you to embed dynamic searh results or individual places in your WordPress sidebar. Also uses the Praized Searchlet featured above.
5. Plugin administration screen. **Note**: API credentials seen in the picture won't work. You need to [get your own]( :)

== Using the Plugin ==

Once the plugin is installed, activated and the API credentials have been
configured, you will now see an extra button in the WordPress post and page

In visual mode (TinyMCE), the new button is a small praized icon.

In HTML mode, the new button is simply a new form button.

Clicking on the said button will launch the Praized Searchlet, a place/merchant
research tool. Once you have located the merchant you are interested in embedding
in your post/page, simply use the "Embed this place" functionality (or "Embed
this query" for search results).

Once configured to your liking, the searchlet will generate a short code, usually
known as bbcode, shortcode or markdown ([praized ...]) that will be translated to
XHTML when your post or page is viewed by your readers. You can preview how the
output will look like by using the WP post/page preview features.

You can also access the Praized Searchlet's functionality by assigning the Praized
Widget in WP Admin -> Design -> Widgets. This will allow you to feature a specific
place, or search result, in your WordPress sidebars.

If your WordPress install is already setup to use WP caching, you can turn on
caching for our embedded badges and lists through the Praized Tools admin screen.
This will speed up page rendering in high traffic site by inssuring that the
plugin does not connect to our API at each pageload, but simply refreshes the
data at your desired interval. Please note that when using advanced WP caching
plugins such as WP-Super-Cache, the said plugin's caching configuration might
take precedence over ours (TTL, static files, etc).

Developers can also find our generated [phpdoc](
documentation output in /wp-content/plugins/praized-tools/phpdocs/.

###Third Party Plugins/Themes Integration###

Although not as advanced as the development tools we make available with our
Praized Community plugin, we have still enabled a few basic API integration
function within the praized-tools.php plugin file.

* pzdt_merchants_get(): returns a list, as PHP object
* pzdt_merchants_search(): returns a search result, as PHP object
* pzdt_merchant_get(): returns an individual merchant/place, as PHP object
* pzdt_user_get(): returns an individual raized user, as PHP object
* and more

**See also**: generated code documentation in /wp-content/plugins/praized-tools/phpdocs/


The Praized Tools plugin is completely translatable out of the box and comes
with English and French bundles by default..

You can find the localization template you can use to translate the plugin in

See the [WordPress Codex]( for details.

Should you decide to take the time to translate our plugin(s) in your favorite
language before we have a chance to do so ourselves, please feel free to get
in touch with us so we can consider bundling your translation directly with
our source in future releases.

== ChangeLog ==

Version 2.0.1: 2009-06-26

* Updated to praized-php-2.0.1.

Version 2.0: 2009-04-29

* New sidebar widgets for latest questions, latest answers and latest activity.
* Plugin now comes bundled with full French translation if running WordPress in French.
* Updated to praized-php-2.0.
* Updated to praized-wp-core-2.0.

Version 1.7: 2009-01-12

* Tweaked the javascript handling for the administration searchlet and fixed a potential
  jquery issue with the version bundled with WordPress.
* Updated to praized-php-1.7.
* Updated to praized-wp-core-1.7.

Version 1.6: 2008-12-05

* The Praized Tools plugin now comes with a default read-only API key that will link
  back to the Praized Hub ( so you can be up and running within seconds.
* Implemented the improvements to the place aggregation options added in the praized-php
  library, so any kind of Praized place URLs can be parsed and presented
* Updated to praized-php-1.6 to implement the new place resolver API methods.
* Updated to praized-wp-core-1.6 to implement the new place resolver API methods.

Version 1.5.1: 2008-10-24

* Updated to praized-php-1.5.1 to implement a security in the 3rd-party Snoopy library

**Version 1.5: 2008-09-30**

* Added support for post/page level place aggregation (see admin screen)
* Added 16 vote button themes and an option in the admin to select your favorite one.
  Will use the vote button theme from Praized Community if active.
  You can still overwrite this in CSS by changing the background options on and
  within .praized-vote-button.
* Improved the overall appearance and usability of the plugin's admin/settings screen
* The Praized plugins are now officialy hosted on and
  This means that if you install the plugins from there, you will now be automatically
  notified whenever we release an upgradedirectly in the WP admin, and other niceties.
* Updated to praized-php-1.5, whith major improvements...