Wordpress Plugin

This page provides documentation for the Unlock Wordpress plugin.

Unlock provides a Wordpress Plugin which integrates our Paywall application into any WordPress.org site. This is the easiest way to lock content inside of pages and posts so that only your members can access them.

We maintain a WordPress.org site which lets you experience the membership experience from a visitor's point of view: wordpress-demo.unlock-protocol.com.

Pre-requisites

  1. You have deployed your own Lock following the instructions on this page.

  2. You are using wordpress.org to host a WordPress site yourself (wordpress.com website will not work as plugins are restricted on that platform.)

Install the Unlock plugin

Inside the admin section of your WordPress site, click on Plugins > Add New

In the search bar on the plugins page, search for "Unlock Protocol"

Search for the plugin
Click on "Install Now", and then on "Activate".

After this, you're all set and you can start locking content on your posts or pages!

Using the Unlock plugin

You can easily add one or more lock to each page or post. Inside of the Editor, click on the Document settings:

Enter the configuration for this specific page or lock

The configuration is very flexible and lets you customize the number of locks, the calls to actions, the images... and more! Please read this section to get a list of options.

Locking content

The plugin also adds 2 "blocks" to your Gutenberg Editor. The first block lets you hide/show content based on whether the current visitor owns a key to your lock. This block can include other blocks so you can easily lock images or any other content.

The second block is actually a button to let your visitors purchase an access key to your lock.

Showing content to members only (hiding it for non members)

Like any other block, click on the ⊕ sign to add an "Unlock Protocol Block".

Once added to the page, the block contains a visual indication (only when editing the post!) to show the block's status: you can easily toggle between content that's only available for members and content that is not available for members.

From there you can add more content which will only be visible by members. The Unlock Blocks can include their own nested blocks, making it easy to lock images, videos, or even attachments.

You can click on the Ʉ at any point to display the setting for this block.

Showing a button to let visitors become members

The Editor also lets you chose a "Checkout Button" which users can click on to become members! You might want to add this button inside of a "non-members only" block!

Once added to the page you can customize its text. The button defaults to the template style.

Make sure you save your post or page once it's been configured!