Display a portion of a post content only to users of a specific role or to a single or multiple users.
* [Private Content](#private-content)
* [Description](#description)
* [Privacy Policy](#privacy-policy)
* [Installation](#installation)
* [Frequently Asked Questions](#frequently-asked-questions)
* [Is there a way to display an alternate text to readers that haven't the rights to read the hidden text?](#is-there-a-way-to-display-an-alternate-text-to-readers-that-havent-the-rights-to-read-the-hidden-text)
* [The hidden text is similar to the public text. Is it possible to stylize it in a different look?](#the-hidden-text-is-similar-to-the-public-text-is-it-possible-to-stylize-it-in-a-different-look)
* [Does this plugin work with custom roles?](#does-this-plugin-work-with-custom-roles)
* [Screenshots](#screenshots)
* [1. At the center of the screen, the shortcode is used in the WordPress editor. The text inside the shortcode will be displayed only to Authors and above roles](#1-at-the-center-of-the-screen-the-shortcode-is-used-in-the-wordpress-editor-the-text-inside-the-shortcode-will-be-displayed-only-to-authors-and-above-roles)
* [2. The shortcode in action. On the left, the text revealed to Administrators only; on the right, the page as seen by lower roles (Editors, Authors, etc., or simply readers)](#2-the-shortcode-in-action-on-the-left-the-text-revealed-to-administrators-only-on-the-right-the-page-as-seen-by-lower-roles-editors-authors-etc-or-simply-readers)
* [Upgrade Notice](#upgrade-notice)
* [2.0](#20)
* [2.5](#25)
* [1.0](#10)
* [Credits](#credits)
## Description
This plugin provides a shortcode to display a portion of a post content only to users of a specific role. For example, you can show the hidden text to Editors or to Authors or to any other WordPress role.
Please, note that an Administrator can read an Editor private content or a Subscriber private content, and so on. Same thing for Editor, Author, Contributor, and Subscriber: a higher role can read a lower role content.
Also you can show the hidden text **only** to a certain role. For example, you can mark a text as visible only to Contributors and hide it to higher roles, such as Administrators or Editors and so on.
As of version 3.0 you can mark a text as visible only to a certain user, using his login name.
As of version 4.0 you can mark a text as visible to multiple users, using their login names comma separated.
As of version 4.3 you can use either the usual `private` shortcode or the extra `ubn_private`, in case the first is already in use.
As of version 5.0 you can use the new option `reverse` to change the logic of the `recipient` option. If `reverse` is activated, it will not allow users in `recipient` read the private note.
As of version 6.0 you can use custom roles.
For more information, please see the [official Wiki on GitHub](https://github.com/aldolat/private-content/wiki).
### Privacy Policy
This plugin does not collect any user data.
## Installation
This section describes how to install the plugin and get it working.
1. Upload the `private-content` directory to the `/wp-content/plugins/` directory
2. Activate the plugin through the Plugins menu in WordPress
3. Now the shortcode is available and ready to use.
## Frequently Asked Questions
### Is there a way to display an alternate text to readers that haven't the rights to read the hidden text?
This plugin is not intended to be used in such way, but only in order to display a portion of a post to certain readers. Also, the hidden text must remain hidden, without the presence of an alternate text that could reveal the presence of the hidden text. Anyway, as of version 2.2, the plugin can display an alternate text, if it's necessary: you can use the `alt` option to do that.
Also, this plugin was created only to show a small piece of text (i.e. a couple of lines) as a note to the post for particular readers.
If you need to show the entire post only to certain readers (i.e. readers who pay to read a post), you can use a plugin like [Members](https://wordpress.org/plugins/members/).
### The hidden text is similar to the public text. Is it possible to stylize it in a different look?
Yes, you have to edit the CSS file of your current theme.
The shortcode generates a `` HTML tag with some classes, for example:
* `private` to stylize all private contents
* `[role]-content` to stylize the content for that specific [role].
* `[role]-only` to stylize the content for that specific [role] only.
See the [official Wiki](https://github.com/aldolat/private-content/wiki#giving-a-style-to-the-text-generated-by-private-content) for more information.
### Does this plugin work with custom roles?
Yes, custom roles are fully supported starting from version 6.0.
## Screenshots
### 1. At the center of the screen, the shortcode is used in the WordPress editor. The text inside the shortcode will be displayed only to Authors and above roles
### 2. The shortcode in action. On the left, the text revealed to Administrators only; on the right, the page as seen by lower roles (Editors, Authors, etc., or simply readers)
## Upgrade Notice
### 2.0
Upgrade in order to use the new role-only feature.
### 2.5
Removed shortcode execution in feed.
### 1.0
No upgrade notice.
## Credits
Many thanks to:
* [Jean Baptiste Jung](http://www.wprecipes.com/add-private-notes-to-your-wordpress-blog-posts) for the idea behind this plugin;
* [Jeff Starr](http://digwp.com/2010/05/private-content-posts-shortcode) for the initial code.
[CHANGELOG]: ./CHANGELOG.md
[LICENSE]: ./gpl-3.0.txt
[README]: ./README.md
[version-badge]: https://img.shields.io/badge/Version-6.0-blue.svg
[requires-badge]: https://img.shields.io/badge/Requires_WordPress-3.0.0-green.svg
[tested-badge]: https://img.shields.io/badge/Tested_up_to_WordPress-5.3-green.svg
[license-badge]: https://img.shields.io/badge/License-GPLv3-ff69b4.svg