Pageflip5 documentation

Pageflip5 Plugin for WordPress

The Pageflip5 WordPress Plugin let you display Pageflip5 books in Wordpress blog posts, using a simple shortcode: [pageflip5]

This page will guide you through the install process, and basic book setup process.

Get the Plugin

Please note, that the plugin itself, is only a bridge between WordPress and Pageflip5, and the GPL2 license terms are applied to it. As Pageflip is a commercial software, the pageflip-min.js core Javascript file is not part of this plugin package, so if you downloaded it from other source than, the pageflip-min.js file have to be uploaded in the plugin's js folder.

If you purchase a Pageflip5 license, your download package will contains the WordPress Plugin with pageflip5-min.js included.

If you don't purchased a Pageflip5 license, then Get a license now!

Install the Plugin

Unzip the downloaded package. (Again, if you downloaded the Plugin from other sources than, please get the pageflip5-min.js from the purchased product package!)

Upload pageflip5_wp_plugin folder to the WordPress Plugin folder: /wp-content/plugins/

Activate the Plugin

After you installed the plugin, enter into your WordPress blog's Admin area, click on the Plugins/Installed Plugins menu item on the left side, and activate the Pageflip5 plugin, with the "Activate" option below the name of the plugin:


Unlock the Plugin

You have to unlock Pageflip5 in order to make it working. Unlocking is done by filling Copyright Text and the Key input field on the Pageflip5 plugin settings page, which can be accessed from the Settings/Pagelfip5 menu item:


Generate Your own Key for Pageflip5 using the online Key Generator. You will be asked to enter your unique Pageflip5 License-Key, Allowed Domains, and a Copyright Text.

Allowed Domains have to contains the Domain on which your WordPress blog is located

Copyright Text You can enter here anything you want

Press the Generate Key button on the bottom of the page, then copy & paste the content of the Copyright Text, and the Key fields into your WordPress plugin settings page. Save Changes, and you're ready to make Your own books on your WordPress blog.


Easy Setup

The easiest way to setup a book, is to attach the book page images (a serie of images, preferably with the same dimension) to the Blog-post using the Add Media button, then add this shortcode to the Blog-post body text: [pageflip5]


Shortcode Attributes

You aren't limited to use books with the default settings (see later), you can add attributes to the [pageflip5] shortcode. There are two types of attributes:

  • Plugin attributes
  • Pageflip config attributes

Plugin Attributes

The Plugin Attributes are handled by the plugin, they aren't passed to the Pageflip5 engine. They are used, when multiple books are displayed on the same page. As only one Pageflip5 book can be shown on a web page, the hidden books can be opened by clicking on a link.

ID of the book, it is also used in the URL hash generated by Pageflip5, and added as CSS class name to the book main parts in the DOM, helping styling the book.
name="My Book Name"
Used in book opening link.


Adding a unique ID to the book helps deep linking in the book, even there is more books on the page.

Pageflip Config Attributes

By default Pageflip is set up using Config Options, set in javascript and discussed here, but in WordPress, we don't have access to scripting this way, so as we have a shortcode ( [pageflip5] ), we added all Config Option, as an Attribute.

All WordPress shortcode attributes have to be lowercase, and the value is inside quotes:

While in javascript the same Config Options are set this way:

All Pageflip Config Attributes set in the shortcode will override the default Config Options set in the Plugins Setting page.

Advanced Setup

On the Documentation's Content Setup page we can learn how to add content to the book. When we use the WordPress Pageflip5 Plugin, the same content isn't defined in html, but added inside opening and closing shortcode tags:

Using the Plugin, you still have the possibility to define content in an external html file:

Please note, that linking files this way will point to the root of the WordPress blog.