Rich Snippets WordPress Plugin Documentation

Rich Snippets WordPress Plugin
Type WordPress Plugin
Current Version 1.6.2
Requires WordPress 3.5 or higher
Compatible up to 4.6
Last update 12.08.2016
Rating
based on 56 ratings

Version history

  • 1.6.2 (Aug. 12, 2016)
    • General compatibility with WordPress 4.6.
    • Fix a WordPress warning on get_currentuserinfo() usage
    • Fix: load translation files even when the plugin folder has been renamed
  • 1.6.1 (Nov. 30, 2015)
    • Fixed an issue with the event example shortcode.
    • General compatibility with WordPress 4.4
  • 1.6.0 (Oct. 26, 2015)
  • 1.5.0 (Aug, 15. 2015)
    • New: added uninstall.php for a clean uninstallation
    • General compatibility with WordPress 4.3
  • 1.4.8 (Jul, 29. 2015)
    • Fix: Some CSS will break the normal "Add media" modal window.
  • 1.4.7 (Jul, 22. 2015)
    • Some cosmetical CSS changes
    • General compatibility with WordPress 4.3
  • 1.4.6 (Dec, 17. 2014)
    • General compatibility to WordPress 4.1 (tested with RC-1)
    • Fix: Now allowing to edit "delete_posts" capability
  • 1.4.5 (Nov, 06. 2014)
    • Fix: Fixes an issue when used together with wpMandrill (giving you the error: "wp_mail() has been declared by another process or plugin, so you won't be able to use Mandrill until the problem is solved.")
  • 1.4.4 (July 15. 2014)
    • Replaced a deprecated jQuery function that was used in the plugin
  • 1.4.3 (May 27. 2014)
    • Fixed a problem where a post couldn't be saved when capability handling has been deactivated
    • New retina icon in the backend
  • 1.4.2 (Dec, 16. 2013)
    • Updated WP-Buddy Framework again. Fixes a bug where the plugin checks for updates too often on certain WP installations
  • 1.4.1 (Nov, 21. 2013)
    • Updated WP-Buddy Framework (especially the update functionality which - in some cases - checks for updates too often)
  • 1.4 (Nov, 05. 2013)
    • New: Easy-to-use Editor button for WordPress' built-in visual editor
    • Some language updates
  • 1.3.3 (Oct, 25. 2013)
    • Fixed an issue where the capability handling did not work in WordPress 3.7
  • 1.3.2 (Oct, 25. 2013)
    • Fixed an issue where the plugin breaks because of WordPress 3.7
  • 1.3.1 (Aug, 19. 2013)
    • Solved an issue where the page load takes a real long time because the plugin permanently checks for updates
  • 1.3 (July 31, 2013)
    • Making the plugin compatible with WordPress 3.6
    • Updated WP-Buddy Plugin Framework
    • Moved languages files to a new directory
    • Updated the examples
    • Made language files available on github
  • 1.2.2 (Apr. 09 2013)
  • 1.2.1 (Apr. 02 2013)
    • Update to the latest WP-Buddy Plugin Framework (compatibility with other WP-Buddy products)
  • 1.2 (Mar. 25 2013)
    • Improved compatibility with other WP-Buddy products
    • Solves the problem that WooCommerce could not be edited
    • Some other bugfixes
  • 1.1.3 (Feb. 7 2013)
    • Updated the examples that get installed automatically during the first activation of the plugin
    • New: Integrated some helpful links on the shortcode editing screen
    • Some other bugfixes
  • 1.1.2
    • Solves the problem that the examples could not be installed
  • 1.1.1
    • New: Adds the possibility to manage who can add new shortcodes
    • New: completely replaced the capability functionality in v.1.1 with a new capability engine which writes the new capabilities directly into the database (where it should be). Now it‘s possible to use WordPress‘ current_user_can() function to check whether a user can modify the current page type.
  • 1.1
    • New: Adds the possibility to manage who can access the shortcode post type (uses WordPress‘ built-in capabilities and roles)
    • The shortcode menu-icon has been updated
    • Adds the possibility to use shortcodes in text widgets, too.
  • 1.0 (Nov. 21 2012)
    • The first version of this plugin

Thank you for purchasing my Rich Snippets WordPress plugin. If you have any questions that are beyond the scope of this documentation sites, please feel free to email me via my contact form here. Thanks so much!

 

What this plugin can do for you

Have you ever seen that cool stuff that „pimps“ search results on google.com? It may look like this:

Rich Snippets Examples

This plugin helps you to generate this search results by using structured microdata. The plugin automatically pre-installs seven shortcodes that are ready-to-use. But it‘s also possible to create new shortcodes with microdata that you need for you purposes.

Quick Start

1. Installation

  1. Upload the rich-snippets-wordpress plugin folder to the /wp-content/plugins/ directory.
  2. Activate the Rich Snippets WordPress Plugin through the „Plugins“ menu in WordPress.
  3. Create and manage the plugin by going to the „Shortcode“ menu that appears in your admin panel.

2. Set up a Shortcode

  1. Go to your WordPress Admin Panel and click Shortcodes.
  2. Click „Add new“.
    Add new shortcode
  3. Type in a name of your new shortcode (1). The title will be automatically transformed into a suitable shortcode-name (2).
    Add new Shortcode
  4. Add the attributes you want to use with the new shorcode. For this, click „Add new attribute“ (1). Then type in your attribute-name into the field that appears (2). The shortcode will be updated as soon as you leave the field (3).
Please note: It‘s not possible to use special characters as WordPress cannot deal with that. So all special characters as well as spaces will be automatically removed.
    Add new Shortcode
  5. In the textarea-field below you can choose how the shortcode should look like. For this you can use HTML or PHP. If you use PHP please only use the <?php and ?> tags to open and close PHP-embedded scripts. Do not use <% or anything else. Please refer to #3 and #4 in this documentation for more information on how to use this field.
  6. In the second textarea it‘s possible to add your own CSS for styling the HTML code. It will be included in the frontends HTML-header.
  7. Save your new shortcode.
  8. Copy and paste the shortcode to use it anywhere in your posts or pages.

3. Use the HTML field

In the HTML / PHP Code textarea you can choose how your shortcode should look like in the frontend. The variables from the attributes are listed where it says „You can use the following placeholders:“.

Example 1:

If your shortcode is the following one:

You  can perform the source code like this:

In the frontend HTML code it will look like this:

In fact: the placeholder will be filled with the content from the attribute.

Example 2:

If your shortcode is the following one:

You can perform the source code like this:

In the frontend HTML code it will look like this:

Please watch the picture below. The [content]-variable (1) is always the content between the start- and the end-tag of the shortcode (see Example 2 above). To make WordPress doing shortcodes between shortcodes you can use the do_shortcode() PHP function listed in (2).
Every other placeholder, for example the [name]-attribute (3), can be used as variables inside the source code to represent the attributes content (4).

Insert PHP Code

Please check out the shortcodes that are delivered with this plugin as well.

4. Use PHP within the HTML field

If you use PHP please only use the <?php and ?> tags to open and close PHP-embedded scripts. Do not use <% or anything else. For every new shortcode PHP will create a function. In this function the placeshoders exists as variables. For example: The [name] attribute is available as the $name variable and you can do what you want with it.
Please note that the placeholders will still be replaced after the PHP code was executed.

5. Test

  • If you are using Rich Snippets you can test your new shortcodes by using Google‘s Rich Snippet Testing Tool which you can find here: http://www.google.com/webmasters/tools/richsnippet
  • Please note that search engines do not support all kinds of microdata at the moment.
  • Please also note: Google says that there is no guarantee that a Rich Snippets will be shown for your page on actual search results.