WordPress.org

Plugin Directory

Content Reveal

Content Reveal allows you to easily hide and reveal WordPress content, whether it's in the sidebar or in a post or page.

Using the Short Code

The short code is [reveal] and it can be used in one of two ways - either using the shortcode twice or by closing it, as usual. For example...

[reveal heading="<h2>%image% Some Blah Content Below</h2>" id="id1"]Blah, blah, blah content here[reveal]

Or you can specify it as...

[reveal heading="<h2>%image% Some Blah Content Below</h2>" id="id1"]Blah, blah, blah content here[/reveal]

The following parameters are valid...

  • heading - This is the heading that you click on to hide/reveal the content below. It can contain HTML. If you wish a button image to appear within the heading then you need to add %image% within the heading, where you wish it to appear. A default button is included with the plugin, but this can be overridden using further parameters. Additionally, if you wish the heading text to change as the content is hidden or revealed then you can specify the title text as %title%. There are 2 further parameters where you then specify the 2 pieces of text.
  • id - You can have multiple reveals on the same page but each needs its own unique ID - keep this short.
  • default - Do you want the content to be hidden or shown by default? Specify hide or show to indicate (default is hide, although you can change this in the options screen).
  • folder - If you wish to supply your own images you can specify your own folder here - see the appropriate section below for more details. The old parameter of img_url can still be used.
  • ext - Use this to specify whether you wish to use PNG or GIF images.
  • cookie - How many hours to retain the cookie for - see the instructions on cookies for further assistance.
  • title1 - If you wish to switch the title text, dependant on states, then this is the text that appears when the text is hidden.
  • title2 - This is the text that will appear when the text is shown.

Important: Make sure you add this using the html/code editor in WordPress, not the visual editor. If you use the visual editor it will not work, as the actual code you entered will be seen on the page, instead of being processed by the script.

Embedding content reveal within another

It is possible to add one content reveal section within another. Here is an example of how to do this - note the use of the end tags to achieve this.

[reveal heading="<h2>%image% Some Blah Content Below</h2>" id="id1"]Blah, blah, blah content here[reveal heading="<h3>%image% Some More Blah Content Below</h2>" id="id2"]Blah, blah, blah more content here[reveal][/reveal]

Change the default icons

The parameter folder may be used to specify a different folder in which you can add your icons. The icons must be named image1 and image2 and can be either .gif or .png images.

You can either specify a full URL or a folder name. In the latter case, it will be assumed the folder is within wp-content/uploads/content-reveal/. The advantage of the latter is that images in this folder will be omitted from Jetpack's Photon function - please see the next section for details on this.

Use of Photon

If you use Photon, which is part of Jetpack, to cache your images then you may find it breaks the images used by this plugin - this is because of the way we use JavaScript to dynamically modify the URL.

The default icons are automatically omitted from Photon and also any icons added to wp-content/uploads/content-reveal/. If you provide icons from any other folder and use Photon then you may find they don't display correctly.

Show title separately

If you wish to show the title separately from the hidden/reveal text then an alternative shortcode is available, named reveal_link. It uses the same parameters as before.

To get this to work you must specify your text as usual BUT give it a heading of "noheading". For example...

[reveal heading="noheading" id="id1"]Blah, blah, blah content here[/reveal]
[reveal_link heading="<h2>%image% Some Blah Content Below</h2>" id="id1"]

This is the same example as previously uses BUT the text to hide/reveal appears BEFORE the title.

In previous use the ID does not need to be specified - if it isn't, one will be generated automatically. However, for this method to use both IDs must match and, hence, you must specify them.

Note: WordPress does not support square brackets in shortcode parameters so you cannot, for instance, use square brackets in the title when using the shortcode option. This is a limitation of WordPress and not this plugin.

URL parameter to change the default state

A URL parameter named acr_state can be used to override all content on the page which uses this plugin. There are 3 possible values - show, hide or off. The latter will cause the plugin to output as if it wasn't active - all content will be shown and toggle images will be suppressed.

Cookies

A JavaScript cookie can be used to remember the last state a user had some content in. This option is switched off by default.

In the Administration menu you should find an option under "Settings" named "Content Reveal". Within here you can switch the cookies on and state how long they should be stored for.

Additionally, you can control cookies on a case-by-case basis via a new parameter named cookie. The value should be set to the number of hours you wish the state to be stored for. To switch cookies off, specify this as zero. For example, with the shortcode you may put...

[reveal heading="<h2>%image% Some Blah Content Below</h2>" id="id1" cookie="3"]Blah, blah, blah content here[reveal]

This would save the cookie for 3 hours.

To assist with recent ICO regulation in the UK with regard to cookies a number of additional features exist...

  1. Setting the cookie time to zero will cause any existing cookies to be deleted and no cookies will be created
  2. All cookies for this plugin can be overridden for a page via the URL. Simply append a parameter of acr_cookies= to the URL, followed by the number of hours (0 to switch off). e.g. for my site a URL of artiss.co.uk?acr_cookies=0 would cause all the current user's cookies for this plugin to be deleted
  3. So that you can display how long cookies are stored for, say on a cookie policy page, a new shortcode of [acr_cookies] exists. An example of output may be 7 days

The cookie is named content_reveal_x, where x is the ID of the given content section.

Other Settings

As previously mentioned in the Administration menu there is an option under "Settings" named "Content Reveal". Apart from the cookie settings, you can also set the default state for showing or hiding content. You can also decide whether to switch on or off the editor button - this is an additonal button that appears in the visual editor and, when pressed, creates a default example of the shortcode.

Reviews & Mentions

Using Simple Content Reveal to report changes to the factual content of articles

Example usage on the Beat Struggles website

Requires: 3.3 or higher
Compatible up to: 4.5.2
Last Updated: 1 month ago
Active Installs: 1,000+

Ratings

5 out of 5 stars

Support

2 of 3 support threads in the last two months have been marked resolved.

Got something to say? Need help?

Compatibility

+
=
Not enough data

0 people say it works.
0 people say it's broken.

100,3,3
0,1,0 100,1,1
100,1,1
50,2,1
100,1,1
100,1,1
100,2,2 100,1,1 100,1,1
100,1,1
100,1,1
100,1,1
100,1,1
100,1,1
100,1,1
0,1,0
0,1,0
100,1,1
100,1,1