OptiPub

Wistia

Embeds Wistia videos when video content is configured to use Wistia as the player. Sends video IDs to fast.wistia.net only when displaying Wistia video content. Data collection is controlled by Wistia’s privacy policy.

• Service Provider: Wistia, Inc.
• Terms of Use: https://wistia.com/terms
• Privacy Policy: https://wistia.com/privacy

OptiPub API

Synchronizes content (publications, resources, videos, FAQs, authors, tags, categories, redirects) from the OptiPub platform to WordPress. Sends authenticated API requests with encrypted tokens to your configured OptiPub domain (typically https://<domain>.app.optipub.com ) via WP-Cron at configured intervals (default: every 5 minutes). Also creates edit links to OptiPub content management pages in WordPress admin.

• Service Provider: OptiPub
• Terms of Use & Privacy Policy: Please refer to your OptiPub service agreement for terms of use and privacy policy.

Third Party Libraries

This plugin includes one minified JavaScript library for video functionality:

• Video.js v4.6.3 – Used for video player functionality Source Code Repository: https://github.com/videojs/video.js/tree/v4.6.3
• License: Apache 2.0
• Location in Plugin: public/js/video.js
• Documentation: https://docs.videojs.com/

The source code for this minified library is publicly available at the GitHub repository link above. This plugin does not include any custom build process – the minified file is used directly from the Video.js project.

Development Documentation

Technical documentation for developers working with the OptiPub plugin. Topics covered:

• OptiPub Introduction
• Prepare
• Installation
• Activation
• OptiPub Admin Page (Save Changes Button, Clear Data Button)
• Cron Job & Troubleshooting
• Plugin Configurations (wp-config.php, Configuring WP-Cron)
• Deactivation & Rescheduling the cron job
• Uninstallation
• Theme dependencies

OptiPub Introduction

OptiPub syncs OptiPub Resources to a WordPress installation. The plugin schedules the WP-Cron event optipub_sync to sync Publications, Resources, Videos, FAQs, Authors, Pages, Custom Content, Tags, Categories and Redirects.

The plugin creates Custom Post Types (CPTs): Resources , Videos , FAQs and Authors . Resources synced to these post types store OptiPub metadata and properties in the wp_postmeta table. OptiPub Tags are saved as WordPress Tags. OptiPub Resource Categories are saved as WordPress Categories.

WordPress Widgets can be created with OptiPub Custom Content from the OptiPub Admin page.

Prepare

From WordPress Admin: Settings > General, select timezone (recommended: ‘New York’) and click [Save Changes].

OptiPub syncs with UTC but displays dates in EST. If you don’t select ‘New York’, website dates may differ from OptiPub dates. WordPress automatically converts post_date and post_modified to the selected timezone. Configure this before syncing data.

Bitnami permissions and configurations (Optional)

Note: This section is only required if you’re using Bitnami WordPress. Skip this if you’re using a standard WordPress installation.

Increase upload file size: 1. sudo -i 2. sudo nano /opt/bitnami/php/etc/php.ini 3. Update upload_max_filesize , e.g. upload_max_filesize = 128M 4. Restart: sudo /opt/bitnami/ctlscript.sh restart

Set permissions before activation (required for proper activation and uninstallation – vendor files need deletion permissions):

Note: These commands apply to all WP plugins. Modify paths to target only OptiPub if needed.

1. 01sudo find /home/bitnami/apps/wordpress/htdocs/wp-content/plugins/ -type d -exec chmod 775 {} \;
2. 02sudo find /home/bitnami/apps/wordpress/htdocs/wp-content/plugins/ -type f -exec chmod 664 {} \;
3. 03sudo chown -R bitnami:daemon /home/bitnami/apps/wordpress/htdocs/wp-content/plugins/

This sets user/group to bitnami:daemon , file permissions to 664 (read/write for user/group, read for others), and folder permissions to 775 (read/write/execute for user/group, read/execute for others).

Activation

Activate from Plugins page. After activation, a green OptiPub Admin menu item appears in the left sidebar.

Activation Processes

During activation, three processes execute:

1. 04Override WP_CRON_LOCK_TIMEOUT constant – Locates wp-config.php and overrides the constant. See WP_CRON_LOCK_TIMEOUT . Note: May fail in Bitnami if permissions aren’t set first.
2. 05Generate OPTIPUB_KEY encryption key – Generates a random key stored in wp-config.php as OPTIPUB_KEY . Used to encrypt/decrypt the API token during cron job execution.
3. 06Change permalink structure – Changes permalink structure to /%postname%/ to accommodate static pages with multiple slugs (e.g., https://www.energyandcapital.com/pubs-detailed/bab where pubs-detailed/bab is defined in /pages OptiPub API).

OptiPub Admin Page

The green menu icon opens the Admin Page for migrating data from the OptiPub API.

OptiPub Sync Options: 1. OptiPub Domain – HTTPS URL of the OptiPub API 2. API Token – The provided API Token from OptiPub will be used to authenticate with the API. Encrypted and stored in database, decrypted for API calls 3. Open Graph Image Link – Backup/default image URL. Access with: function get_optipub_opengraph_image() { return get_option(\OptiPub\Base\Constants::OPTIPUB_OPENGRAPH_IMAGE_LINK); } 4. WP Auth Token – Create a WP Auth Token to authenticate subscriber logins through OptiPub 5. Home Page Template – Template name from OptiPub: – OptiPub > Administration > Templates – create template with .php extension (e.g., optipub_home_page.php ) – OptiPub > Content > Pages – create page with path / using the template – Optional: OptiPub > Content > Redirects – create redirect from domain.com/home to https://www.domain.com/ 6. Publication Dropdown – Generated after OptiPub Domain and API Token are provided and Save changes is clicked 7. Publication Domain Id – Publication domain ID (integer) used to retrieve redirects

Copy Files To Theme (feature complete – documentation under construction) View more documentation in the plugin ‘OptiPub Admin’ page

1. 07Files copied to [theme-directory]/inc/optipub
2. 08Select file categories and click [Copy Files]
3. 09Reference from current location or use as integration guide

If copying Helper Functions , copy content from [theme-directory]/inc/optipub/php/add_to_bottom_of_functions.php.txt to your theme’s functions.php . include statements and filter/action calls are commented out. Review functions before uncommenting.

Custom Content Widget Sidebars (feature complete – documentation under construction) View more documentation in the plugin ‘OptiPub Admin’ page

Create custom content macro in OptiPub > Content > Custom Content. Custom Content syncs to WordPress as options.

Click [Create New Widget]: – Title – WordPress Admin Console – Sidebar ID – Display widget in theme templates – File Name – WordPress Sidebar Widget content file – Description – WordPress Admin Console – Custom Content – OptiPub custom content macro name – Class Name – CSS class for styling – Before Widget – HTML before widget – After Widget – HTML after widget – Before Title – HTML before title (displays Title if used) – After Title – HTML after title (displays Title if used)

How OptiPub Custom Content creates WordPress Sidebar Widgets:

Widget files created at: [theme-directory]/inc/optipub/widget-templates/ File Name

Default content: <?php echo get_option('{$custom_content_name}'); ?>

Include in theme templates: if (is_active_sidebar('sidebar-id')) { dynamic_sidebar('sidebar-id'); }

Save Changes Button

Validates API Domain and token, then stores Optipub Domain , Api Token , Publication , Publication Domain , Header Pencil Ad Macro , Article bottom Ad Macro , Signup Sidebar Macro in wp_options table.

Schedules cron job to run every 5 minutes if Optipub Domain , Api Token , and Publication are provided correctly.

After saving, an API call fetches publication metadata. Fetched metadata appears in the WordPress admin left menu. New CPT links appear in green to differentiate from other CPTs.

Clear Data Button

Cl