PrivateContent

Documentation for v7.0 and later


Introduction

Before going through documentation chapters, thanks for purchasing PrivateContent and trusting LCweb!

Need further help?

Open a ticket

Need a customization?

Ask for a quote

Installation

Be careful using CACHE SYSTEMS. PrivateContent is based on dynamic content changes, then you MUST AVOID static cache systems (eg. WP Super Cache, WP Fastest Cache, etc).

On LCweb's website Cloudflare + LC Scripts Optimizer are used. In the past was used W3 Total Cache, but avoiding any static cache

On multisite WordPress installations the plugin must be activated individually on any subsite and every subsite will have its own users database

Categories and Users Management

WordPress User Sync

Basically this system associates one mirror WordPress user to a PrivateContent user. This is essential to let them interact with WP-based systems (comments, woocommerce, etc). Users will still be managed through the privateContent interface.

  • To be synced, a privateContent user must have a valid and unique e-mail
  • Username and e-mail must not match with ones already used for existing WP users
  • You must not edit or delete synced wordpress users or you will lose the sync.
  • Once synced, you can't edit a privateContent username or e-mail. You must detach him before
  • For the same reason also User Data add-on custom forms won't have e-mail field if this system is enabled
  • Of course you can't be logged as WP admininstrator and as synced pvtContent user at the same time
  • Synced users will be able to log in/out also through wordpress forms
  • Detaching a user you will automatically delete the WordPress mirror

FYI: mirror WordPress users have got pvtcontent role and can't enter the admin area.
Additional roles can be emulated, adding capabilities to synced users. This is managed in the related settings area.

Users registration

Paginated forms

It's possible to split forms into sections. In the form builder there's an element called "paginator", using it, users will be prompted to fill one section per time. Really useful in case of complex forms.

HTML5 fields validation

PrivateContent has got an HTML5 form validation engine acting on client-side. This offers detailed error reports to user and avoid multiple server calls.

It also integrates with form sections. If fields aren't correct, user can't move to next form's section.

Custom form styling

You can also set a fluid layout for the registration form and create your color combination.
To enable custom theme, you must choose "custom" under "Frontend style" option

Anti-spam systems

By default PrivateContent has got an invisible "honey pot" system. It is almost secure as reCAPTCHA, anyway you can always choose to use this latter one.

PrivateContent integrates Google invisible reCAPTCHA. You are now asked to register on Google's site and insert site + secret keys.

Using WordPress forms

Using WP user sync system, you can also use any registration form you may have on your website to create PrivateContent users.

Newly registered users will be automatically turned into PrivateContent users, then be careful to which roles they're gonna have!

Import & Export Users

Since each user category and user page is deeply integrated with WordPress IDs, isn't possible to import exported users.The only way to completely move users is to move the whole site database.

Import

The import system is available only if your server has got "allow_url_fopen" PHP.ini instruction enabled

The import system requires a precise a CSV file with 6 columns. This is the fields order:

name surname username password e-mail telephone
Additional notes:
  • Username and password are mandatory
  • Password must comply with strength settings
  • Username must be unique
  • E-mail must valid

Download demo CSV

Import WP Users

This system is available only if WP user sync is enabled

Just choose which user roles will be imported and which PvtContent user categories to assign.
Remember that sync can't be reverted without WP users deletion, then be careful to what you sync!

Export

Select user status, file format and user categories you want to export.
The resulting file will be downloaded on your desktop.

Users private page

Private Comments
Using Wordpress user sync system, PrivateContent gives you the ability to communicate with users directly on their private page.
It must be synced and comments must be enabled on its private page.

Lightbox engine

PrivateContent has got a powerful lightbox engine you can use to pop up forms or notifications or whatever you need.
Just one note about contents: they are AJAX loaded, then using javascript-based elements, be sure they are ok.

In settings you'll find the related lightbox wizard.
Once added, you'll note two classes in the upper-right corner: trigger class and lightbox class.

Lightbox class

Wrapper class used in the lightbox, useful for CSS or javascript customizations

Trigger class

Is the class needed to launch lightboxes. In fact lightbox instances can be linked to warning box buttons, but only through these classes you'll be able to use them everywhere in your website.

Let's see implementation examples:

Trigger lightbox from WP editor (or any HTML code)

Use the editor in TEXT mode and add the CLASS attribute to the element you wanna use as trigger

Implementing lightbox in Visual Composer elements

In this screenshot a button has been taken into considereation, but almost any Visual Composer's element has got an extra class field.
If you are using Elementor, just do the same in the related "element class" field.

Trigger lightbox using a wordpress menu item

Simply add a "Custom link" menu using an hash as URL and any text you need.
Then, once added, expand the menu item and add the class.

FYI: if you don't see the class field, enable it through "Screen Options" flap, on top of the page.

Shortcodes Wizard

PrivateContent is also natively integrated with Visual Composer, Elementor and Cornerstone.
Using them, you can skip the standard shortcode wizard and use the related PrivateContent tool.

Let's analyze all available shortcodes and their parameters:

Private Block

[pc-pvt-content allow="all" block="" warning="1" message="1" login_lb="" registr_lb=""][/pc-pvt-content]

Used to hide specific page contents. Might show a warning box or just nothing

allow allows specific user categories (using IDs split by comma) or any user using all
block blocks specific user categories. Acts only if you are allowing specific user categories (optional parameter)
warning boolean flag to display/hide the yellow warning box (by default is shown) (optional parameter)
message custom message to show in the warning box (by default is the one specified in the settings) (optional parameter)
login_lb lightbox instance ID attached to "login" button. By default follows global option (optional parameter)
registr_lb lightbox instance ID attached to "registration" button. By default follows global option (optional parameter)

 

Login Form

[pc-login-form redirect="" align="center"]

Simply displays login form (NB: obviously it won't be displayed to logged users)

redirect defines a forced custom redirect for this specific form (optional parameter)
align defines form alignment. Possible values: center, left, right (optional parameter)

 

Logout Box

[pc-logout-box redirect=""]
align defines form alignment. Possible values: center, left, right (optional parameter)

is possible to perform the logout by adding ?pc_logout to any site's URL. Example: mysite.com/?pc_logout

 

Registration Form

[pc-registration-form id="" layout="" custom_categories="" redirect=""]

Used to display the registration form

id registration form id (if not specified, first registration form will be used)
layout set form layout between one_col and fluid (by default is used what set in settings) (optional parameter)
custom_categories defines a forced custom category or multiple categories (comma split) for registered users. It's discarded if you have categories field into the form (use categories ID) (optional parameter)
redirect defines a forced custom redirect for this specific form (optional parameter)
align defines form alignment. Possible values: center, left, right (optional parameter)

 

User Deletion Box

[pc-user-del-box redirect="" align="center"]

Allows user self-deletion from frontend

redirect defines a forced custom redirect for this specific button (optional parameter)

Restrict Contents

By default any wordpress user can access any restricted content except users private pages.

You can change this behavior in the plugin settings:

  • Limiting it to specific user roles with the "Minimum role to use the plugin" option

  • Deactivating it enabling "testing mode" option. In this way also WP users have to log into PrivateContent

Understanding the restriction engine

PrivateContent restrictions are essentially based on user categories.
Advanced users might extend this behavior using plugin's API and introducing new checks though.

In any restriction block you will be asked to specify who can access specific contents. Leaving restriction options empty, no restriction will be applied.

A user can access restricted elements if he belongs to AT LEAST one condition.
For example if you allow "user category 1" and "user category 2", users belonging to "user category 1" OR "user category 2" will be able to access them.

You might be able to also block specific users, among allowed ones.
For example if you allowed "any logged user" and blocked "user category 1" and "user category 2", users belonging to "user category 1" OR "user category 2" won't be able to access contents.

Restrict Targeted Page Contents

Through "Private Block" shortcode you can restrict targeted contents inside any page or post.
Is useful to create dynamic switches. For example: show content X to unlogged and show content Y to logged.

Restrictions wizard

It's the main PrivateContent tool to manage your restrictions. It is shown in any linked post type and taxonomy: by default for posts, categories and pages.
Remember you can extend this to custom post types and taxonomies by selecting them in settings!

An essential concept to understand is inheritance. These restrictions are inherited starting from categories, passing to parent post and ending with child post.

Then you can easily restrict multiple subjects by restricting a category or a common parent page.
Let's analyze its systems:

Contents Hiding

This system acts uniquely on contents, leaving posts searchable, indexable by search engines.
Contents can be replaced with different options, to be chosen in settings: a warning box / no contents / the excerpt / excerpt + warning box / custom contents.

If contents are hidden, also comments will.

Comments

Simply set comments visibility. Optionally you can also replace them with a warning box.
This system is usable only if WP user sync is enabled (otherwise pvtContent users won't be able to interact with comments)

Redirect

The most powerful privateContent restriction: totally hides elements making them unreachable and redirecting blocked users to a predefined page.
It will be totally removed from wordpress queries: won't be searchable nor indexable and will be also removed from menus.

Be careful setting main redirect target in settings: it MUST BE NOT restricted through this system or browser will fall into an infinite loop.

Lightbox on page's opening

FYI: This is a javascript-based system, then IS NOT a safe system to hide page contents. An advanced user could block javascript execution and reach contents underneath

This system will apply a persistent modal lightbox on page's opening.
Contents will be shown but covered by a lightbox that might contain anything (check the related documentation's chapter)

Custom Restrictions

Within PrivateContent settings, you can also set custom restrictions, based on pages URL.

url-base

You can use a full URL or a regular expression, allowing you to control multiple pages at once.
In this image, for example, first restriction targets a single page while second one restricts any page having "category-y" in URL.

Menu and Complete Site Lock

Widgets

widget

PrivateContent integrates also in WordPress widgets management area, allowing you to restrict every widget.
Just specify which user categories will be able to see them.

Google Analytics integration

You can track every step a logged user makes on your website, thanks to the native Google Analytics implementation.
Just inset your tracking ID code and the plugin will start tracking users.

Implementation is done on PHP side, privateContent DOES NOT add the javascript tracking code into your website since almost any theme has got this feature or customers already use specific plugins for this.

As written under the field, you must create a new view to enable users tracking.
Is an analytics requirement and this new view will report ONLY logged users activity

Public API - Extend it!

PrivateContent is a dev-oriented plugin, ready to be extended and tweaked in any way you need.
Check the Public API documentation and knowledge base to understand how.

Want a new and easy income source?
Create your own add-on on Codecanyon. Counting thousands of customers all around the world, PrivateContent guarantees certain sales to your product! Approved add-ons will be featured on LCweb site and mentioned in PrivateContent description.

Want to join add-ons creation but need an idea to start from? Get in touch at support@lcweb.it to know what customers need right now!

Multilanguage

The plugin is 100% multilanguage for both front and back ends. If a translation of your language has been created, WordPress will automatically switch between languages.
Plus it is compatible with WPML, Polylang and qTranslate!

How to create a translation

If you have WPML + String Translation add-on or Polylang, you can simply scan the plugin and translate strings via its UI.

Otherwise: go in the plugin folder, you'll find two folders called "languages" and "lang_admin".
Inside you'll find the default.pot file. It contains english strings to be translated.

If you want to create or customize your language translation, follow these steps:

  1. Open the default.pot file with POedit
  2. Edit the catalog by inserting your data and setting translation's language
  3. Save the file with your language's i18n identifier and "pc_ml-" prefix (the italian example is mg_ml-it_IT)
  4. Go to the plugin folder ".. wp-content/plugins/private-content/languages" or ".. wp-content/plugins/private-content/lang_admin" and paste and paste resulting .PO and .MO files

If you create new translations, please contact me at support@lcweb.it sending your .PO and .MO files.
Otherwise they will be lost in next updates. Thanks!

Existing Localizations (frontend):
Afrikaans (South Africa) To be completed
Argentine To be completed
Brazilian To be completed
Croatian To be completed
Czech To be completed
Danish To be completed
Dutch To be completed
Estonian To be completed
Finnish To be completed
French 100% translated
Georgian To be completed
German To be completed
Greek To be completed
Italian 100% translated
Norwegian To be completed
Persian (Iran) To be completed
Polish To be completed
Romanian To be completed
Russian To be completed
Slovak To be completed
Spanish To be completed
Swedish To be completed
Turkish To be completed

GDPR Infos

This chapter is addressed to users having to deal with GDPR european law and will briefly give you informations about users data management to adhere with european standards:

  • User data are kept uniquely on your server, in a custom database table (and data is mirrored on WP users table if you are using WP user sync system)
  • Passwords are stored using the WordPress hashing system and can't be retrieved nor viewed by anyone
  • Users can totally remove their data from the website using the related box (check shortcodes section)
  • The only cookie used is named "pc_user" and is used to keep user logged in

LCweb - Copyright © 2019 - All Rights Reserved