Skip to content

Display Specific README Information

David Artiss edited this page Nov 14, 2017 · 1 revision

You may wish to add your own section to the output to provide download links, etc. In which case you can suppress this section and then use an additional shortcode to retrieve the information that you need.

Use the shortcode [readme_info] to return one of a number of different pieces of information. Use the required parameter data to specify what you need - this can b...

  • download - Display a download link
  • version - Output the current version number
  • forum - Display a link to the forum
  • wordpress - Display a link to the plugin in the WordPress.org repository

In the cases of the links you must specify text between the opening and closing shortcodes to link to.

There are 4 additional parameters...

  • name - Use this to specify the plugin name. This is a require parameter
  • target - If outputting a link this will assign a target to the output (default is _blank)
  • nofollow - If Yes then this will be a nofollow link. By default it won't be
  • cache - By default any output will be cached for 5 minutes so that if you use this shortcode multiple times on a page the data will only be fetched once. Specify a different number (in minutes) to adjust this. Set to No to switch off caching entirely

An example of usage may be...

[readme_info name="YouTube Embed" data="download"]Download YouTube Embed[/readme_info]

Clone this wiki locally