Category: Tools

X Smtp

Simone Fioravanti

Configure a SMTP server to send email from your site. Adds a page under "General Settings" where you can configure the parameters of the SMTP.

Download

More Info
Switch to ClassicPress

ClassicPress

Switch your WordPress installation to ClassicPress. Also a tool to try different versions of ClassicPress (also nightly builds or RC).

Download

More Info
Basic Info Tool

tradesouthwest

Display site information on your ClassicPress administrator screen to display what version of PHP is running and much more.

Download

More Info
You can pass the information to others, like a support team or maybe to test what version of PHP you have when a plugin tells you that you are required to have a certain version of PHP, in order to load the plugin or theme.

Installation

This section describes how to install the plugin and get it working.
1. Upload the plugin files to the /wp-content/plugins/ directory, or install the plugin through the WordPress plugins screen directly.
2. Activate the plugin through the ‘Plugins’ screen in WordPress
3. Use the ‘Tools’->’Basic Info Tool’ screen to get your WordPress debug information.
4. Copy this information and send it to your developer / support engineer.
Basci Info example

Frequently Asked Questions

Where do I see my debug information =

You may go to ‘Tools’ > ‘Basic Info Tool’ to view your ClassicPress environment debug information.
Changelog

= 1.0.2

fix headers

Initial release

Upgrade Notice

= 1.0.0 = Minor bug fixes
Spoof User Agent

Simone Fioravanti

Change your User Agent to whatever you want. Go to Settings > Spoof User Agent to configure the User Agent exposed when doing HTTP requests.

Download

More Info
W3P SEO

Ciprian Popescu

W3P SEO has options for local business JSON-LD data, Open Graph, optimized SEO defaults, native XML sitemaps and advanced topic clustering settings.

Download

More Info
W3P SEO has options for search engines, such as ownership verification, local business JSON-LD data, Open Graph, analytics, and optimized SEO defaults.

W3P SEO also features native XML sitemaps and advanced topic clustering settings.

For support, feature requests and bug reporting, please visit the official website.

Installation

Upload and activate the plugin.

Changelog

= 1.8.2 =
- Add the proper “WRP SEO” plugin name in a few places
- Remove several WordPress references
- Remove obsolete Web of Trust references
= 1.8.1 =
- FIX: Pass all CPCS guidelines
- UPDATE: Remove lots of obsolete features
= 1.8.0 =
- FIX: Fix Link Whisper feature to use word boundaries, excluding words already inside <a> tags
- FIX: Fix excerpt not working with ClassicPress
- UPDATE: Implement custom meta field for meta description as a fallback for excerpt
- UPDATE: Remove Web of Trust verification
- UPDATE: Remove Majestic verification
= 1.7.7 =
- UPDATE: Update WordPress compatibility
- UPDATE: Add FAQs to supported custom post types
- UPDATE: Add robots meta to complement the header
= 1.7.6 =
- FEATURE: Add option to noindex URLs with query strings
= 1.7.5 =
- FIX: Change meta meter functionality to respond to input instead of keyup events
- FIX: Only loop through content types if XML sitemaps are enabled
- FEATURE: Add Link Whisper functionality (not affiliated with the Link Whisper plugin)
- UPDATE: Update WordPress compatibility
= 1.7.4 =
- UPDATE: Add missing “image” field
- UPDATE: Improve LocalBusiness schema
- UPDATE: Improve image upload functionality
- UPDATE: Update Twitter to X (Twitter)
- UPDATE: Update WordPress compatibility
= 1.7.3 =
- UPDATE: Updated WordPress compatibility
= 1.7.2 =
- UPDATE: Updated WordPress compatibility
= 1.7.1 =
- FIX: Removed property CPT from the list of allowed metabox locations
= 1.7.0 =
- FIX: Fixed description being echoed instead of returned in the <head> element
- FIX: Fixed Open Graph tags property names
- FIX: Fixed WPCS (WordPress Coding Standards)
- UPDATE: Added extra Open Graph tags for Twitter Cards and Pinterest
- UPDATE: Removed old secure_url image Open Graph tag
- PERFORMANCE: Joined all wp_head actions into one
- PERFORMANCE: Changed several options into variables so they can be reused without having to query the database
= 1.6.1 =
- FIX: Fixed auto-adding image attributes from image filename
- FIX: Fixed Schema generating empty image dimensions
- FIX: Sanitized Schema excerpt for the description field
= 1.6.0 =
- UPDATE: Updated author banner
- UPDATE: Updated WordPress compatibility
- UPDATE: Removed unused option (readonly)
= 1.5.9 =
- UPDATE: Added Yoast migrator (temporary)
- UPDATE: Added Meta report for posts
= 1.5.8 =
- FIX: Fixed subpages container not being properly closed
= 1.5.7 =
- FIX: Fixed admin scripts not being enqueued due to broken dependencies
- UI: Improved layout of meta report
= 1.5.6 =
- FIX: Fixed excerpt generation (faster now)
- FIX: Merged two options
- FEATURE: Added Meta Report, similar to Screaming Frog, showing page titles and descriptions
= 1.5.5 =
- FIX: Fixed HTML tags in Schema description/excerpt
- FIX: Fixed duplicate meta description
- UPDATE: Added option to enable/disable SEO title
- UPDATE: Added option to enable/disable SEO meta description
- UPDATE: Improved the [subpages] shortcode
= 1.5.4 =
- UPDATE: Updated SEO title and meta description logic
- UPDATE: Added character counter/meter for SEO titles and meta descriptions
= 1.5.3 =
- FIX: Fixed Sitelinks schema for potentialAction
= 1.5.2 =
- FIX: Fixed several issues with breadcrumbs
- FEATURE: Added better breadcrumbs
= 1.5.1 =
- FIX: Fixed several typos
- FEATURE: Added topic clustering settings
- UPDATE: Started plugin rebranding to W3P
- UPDATE: Updated UI for more intuitive options
= 1.5.0 =
- FIX: Removed unused Facebook administrator ID option
- FEATURE: Added Knowledge Graph Schema details
- FEATURE: Added custom title
- FEATURE: Added excerpt as custom meta description
= 1.4.11 =
- FEATURE: Added native WordPress XML sitemaps
- FEATURE: Added option to automatically add image caption, description and ALT text from image title for all new uploads
- UPDATE: Updated WordPress compatibility
- UPDATE: Updated WPCS (WordPress Coding Standards)
= 1.4.10 =
- FIX: Removed broken custom sitemap functionality
- UPDATE: Updated WordPress compatibility
= 1.4.9.1 =
- UPDATE: Updated WordPress compatibility
= 1.4.9 =
- UPDATE: Updated WordPress compatibility
= 1.4.8 =
- UPDATE: Updated WordPress compatibility
= 1.4.7 =
- FIX: Removed all references to codor class
- UPDATE: Updated all non-secure Schema URL to HTTPS
= 1.4.6 =
- UPDATE: Updated WordPress compatibility
- UPDATE: Removed GIT2SVN integration as it’s not feasible
- UPDATE: Renamed stylesheet to avoid conflicts with other getButterfly plugins
- PERFORMANCE: Removed custom fonts for code blocks for WordPress Dashboard
= 1.4.5 =
- FEATURE: Added sitemap feature
= 1.4.4 =
- FIX: Fixed excerpt generation (strip shortcodes and remove tags)
= 1.4.3 =
- FIX: Fixed excerpt generation
- FIX: Fixed custom excerpt not being generated for homepage
- UPDATE: Admin UI tweaks
= 1.4.2 =
- UPDATE: Removed Facebook admin ID from Open Graph tags
- UPDATE: Added og:image:alt to Open Graph tags
= 1.4.1 =
- UPDATE: Added missing Open Graph tags
- UPDATE: Unified meta description and Open Graph tags
- UPDATE: Added excerpt to pages by default
= 1.4.0 =
- UPDATE: Changed styling of code elements
- UPDATE: Set up groundwork for improved breadcrumbs
- UPDATE: Set up groundwork for improved page descriptions
= 1.3.12 =
- UPDATE: Updated WordPress compatibility
- UPDATE: Incremental testing GIT2SVN
= 1.3.6 =
- UPDATE: Updated help text for custom homepage description
- DEVELOPMENT: Restarted development on GitHub
= 1.3.5 =
- UPDATE: Removed Google+ integration
- UPDATE: Updated PHP requirements
- UPDATE: Updated WordPress compatibility
= 1.3.4 =
- FIX: Removed unused shortcode parameter
- UPDATE: Updated WordPress compatibility
= 1.3.3 =
- UPDATE: Updated string/variable sanitisation
= 1.3.2 =
- UPDATE: Updated plugin name to avoid confusion
- FIX: Fixed readme.txt version
= 1.3.1 =
- UPDATE: Added Baidu verification tag
- UPDATE: Updated Google Tag Manager loading priority
- UPDATE: Removed Google Tag Manager (noscript)
= 1.3.0 =
- UPDATE: Updated WordPress compatibility
- FIX: Added missing Google Analytics and Google Tag Manager tags
- FIX: Added missing header and footer tags
- FIX: Added missing content
= 1.2.1 =
- UPDATE: Updated WordPress compatibility
- FIX: Removed unused files and functions
- FIX: Removed deprecated links
- FIX: Added missing styles (backend)
= 1.2 =
- FIX: Removed double variable declaration
- FIX: Removed unused (inherited) variable declaration
- UPDATE: Moved plugin to Settings area to unclutter menu
- UPDATE: Removed unused welcome mat feature
- UPDATE: UI tweaks
- PERFORMANCE: Removed unused code, fixed line endings and added PSR code changes
= 1.1.3 =
- FEATURE: Added microdata breadcrumbs (unstyled)
= 1.1.2 =
- FIX: Google Tag Manager script position
= 1.1.1 =
- FIX: Fixed excerpt not being generated from the post/page content
- FIX: Fixed settings page description
= 1.1.0 =
- FEATURE: Added welcome mat (scroll mat) feature
- FIX: Fixed performance
= 1.0.4 =
- FIX: Unified gbad.css styles (.codor)
- UPDATE: Removed Google Maps as it now requires a key and a developer account
= 1.0.3 =
- UI: UI and wording tweaks
- UI: Added sharing debugger link for Open Graph/Facebook
- FIX: Added OG schema to DOCTYPE only if Open Graph option is checked
- FIX: Fixed excerpts for SEO description
- FIX: Fixed DOCTYPE prefix for Open Graph
ClassicPress Integrity Checker

Simone Fioravanti

Check core files against MD5.

Download

More Info
Plugin for ClassicPress.

Check core files against MD5.

Filters
- Change URL: cpic-url (default https://api-v1.classicpress.net/v1/checksums/md5/)
- Change requested CP version: cpic-version (default local CP version)
FX Builder

Ciprian Popescu

FX Builder is an improved page builder plugin for ClassicPress that provides visual columns in the post editor without using shortcodes.

Download

More Info
FX Builder is a page builder plugin that provides visual columns in the post editor without using shortcodes. From the settings page, you can enable it for posts, pages, and custom post types.

Changelog

= 1.4.3 =
- Add section duplication feature
- Improve outer section inserter
- Remove rogue console.log
= 1.4.2 =
- Fix undefined array key “row_html_height_unit”
- Fix SCF/ACF outline overlapping the FX column wrapper
- Convert FX switcher to vanilla JavaScript (from jQuery)
= 1.4.1 =
- Fix bottom column selector being displayed as block instead of Flex
= 1.4.0 =
- Fix unescaped variable
- Fix typo in readme.txt
- Add new Settings and Typography options panel
- Add Google fonts and Bunny fonts functionality to TinyMCE’s fontformats array
- Add translatable strings to the Settings page
- Add admin stylesheet
- Update readme.md with helpful links and a short description
- Update ZIP release workflow
- Switch more elements from floats to Flex CSS
- Replace deprecated “resize” function with “resize” event
- Clean up old settings panel (alpha)
- Remove unused filter
- Remove tabbing capability in textarea element
= 1.3.1 =
- Add line height controls
- Add column vertical alignment
- Add 5-column layout
- Add section height controls to create spacers
- Various UI improvements
= 1.3.0 =
- Remove jQuery UI Sortable dependency and replace with SortableJS
- Remove old, unused files
- Update plugin branding to be consistent with “FX Builder”
= 1.2.3 =
- Fix author link
- Add system fonts to TinyMCE
= 1.2.2 =
- Fix undefined variable
- Add image styling to wraps to make sure images are not wider than content
- Remove “Wide” content width, as it’s not relevant, and can be added as a class
= 1.2.1 =
- Add font size presets, custom font size and font weigh to TinyMCE
- Clean up row and item templates
- Clean up front-end styles
- Clean up readme.txt
= 1.2.0 =
- First public release for ClassicPress
= 1.0.2 – 13 Ags 2017 =
- Fix bug: WP 4.8 compat (thanks to nick6352683)
= 1.0.1 – 06 Jan 2017 =
- Fix bug: wp preview remove FX Builder data
- Fix CSS Bug: Tools & CSS button position
- Store _fxb_active in revisions
- Hide “Preview Changes” button in “Publish” meta box when FX Builder is active
- Fix “save_post” hook to fix fatal error bug
= 1.0.0 – 09 Dec 2016 =
- First stable Release
= 1.0.0.beta – 12 Oct 2016 =
- Browser compatibility (Tested with: Firefox, Chrome, IE11, Edge, Android Phone, Tablet)
- Use Admin Color
- UI and UX Improvement
- RTL Support
- Use HTML Class for Front End Output + Update Front CSS
= 1.0.0.alpha3 – 29 Sep 2016 =
- Revision: Revert to Revision now also revert to FX Builder data
- Remove disable editor feature. Simpler Settings
- Change settings option name. You need to re-configure settings
- Page is enabled by default
- Introduce Tools: Export / Import FX Builder data
- Auto focus to editor when open editor modal
- Fix Custom CSS textarea line break
- Fix several small-screen accessibility issue in modal box
= 1.0.0.alpha2 – 23 Sep 2016 =
- Add row with thumbnail for each layoout
- Welcome notice with link to admin page
- Improve overall builder design
- Fix overflow in editor modal
- Add post class “fx-builder-entry” when active
- Reset undo in editor modal
- Custom CSS for each posts
- Other small fixes and improvements
= 1.0.0.alpha – 21 Sep 2016 =
- Initial alpha release
Shorten It

Simone Fioravanti

Create short links, generate corresponding QR code and track hits.

Download

More Info
Plugin for ClassicPress.

Create short link for your posts, your affiliates or your social content.
- Create URL like mysite.com/fb to point to longer internal links or external links like instagram videos, external services or partners.
- Generate QR codes for those links with this plugin (using php-qrcode).
- Keep track of how many times those links are used (without tracking data).
Example

Path: /fbv

Destination: https://www.facebook.com/cris.vardamak/videos/1327994840668572

means that if you connect to https://educatorecinofilo.dog/fbv you will be redirected to https://www.facebook.com/cris.vardamak/videos/1327994840668572.

Conflicts

If redirects are not working properly there may be a conflict with plugins using template_redirect hook.
This hook is used often by SEO plugins to redirect non existing pages.
Take a look at your SEO plugin’s settings.

Screenshots
DebugPress: Debugger in a Popup

Dev4Press

DebugPress is an easy-to-use plugin that implements popups for debugging and profiling website pages with support for intercepting AJAX requests.

Download

More Info
DebugPress is an easy-to-use plugin implementing popup for debugging and profiling currently loaded WordPress powered website page with support for intercepting AJAX requests. The main debugger window is displayed as a popup, activated through the button with the Bug integrated into WordPress Toolbar, or floating on the page.

The plugin currently has a total of 22 tabs in the popup debugger window, showing all kinds of information relevant to the current page, WordPress setup, background AJAX calls, and much more.

The plugin doesn’t modify or replace any WordPress files or functions.

= Home and GitHub =
- Learn more about the plugin: DebugPress Website
- Contribute to plugin development: DebugPress on GitHub
= Quick Overview Video =
https://www.youtube.com/watch?v=-eFnBRLhy-s

= Pretty Print for objects =
To display the content of objects or arrays, plugin has pretty print functionality through use of simpler PrettyPrint library, or more robust third-party library Kint. You can choose one or the other from the plugin Settings, Advanced tab.

= Debugger Panels =
Currently, the plugin has the following panels:
- Basic
- Request (optional)
- Query (for frontend only)
- Content (optional)
- Roles (optional)
- Constants (optional)
- Hooks (optional)
- PHP (optional)
- Server (optional)
- Enqueue (optional)
- SQL Queries (if SQL queries logging is enabled)
- User (optional, if user is logged in only)
- HTTP (optional, if HTTP API calls are captured)
- bbPress (optional, on bbPress forum pages only)
- Plugins (optional, if plugins store data)
- Errors (for all captured PHP errors)
- Doing It Wrong (for captured WordPress Doing It Wrong warnings)
- Deprecated (for captured PHP deprecated warnings)
- AJAX (for captured AJAX calls while page is active)
- Store (for any user stored objects during the page loading)
- Tools (internal and external tools links)
- Debug Log (load content on demand from WordPress ‘debug.log’)
- Layout (control the size, position and activation of the popup)
= SQL Queries =
This panel lists all the queries WordPress has run. It allows you to order the queries by execution order or length of execution, and all queries can be filtered by the query type, database table it targets or the WordPress function that called it. Every query displays the execution time, order, caller functions stack and fully formatted SQL query that is easy to read. For some Dev4Press created plugins (and that list will grow), DebugPress can detect the source of the query and allow you to filter by the plugin calling the query.

= PHP and WordPress Errors =
Plugin has 3 panels dedicated to showing PHP and WordPress errors and warnings. The Plugin captures this information during the page load, and it shows full debug trace as returned by the PHP debug tracing function.

= AJAX =
The plugin tracks every AJAX call coming through WordPress admin-ajax.php handler, and with every response, it returns HTTP headers with AJAX request basic execution information. Right now, plugin is not returning a list of logged errors or SQL queries, because both can produce huge output that goes over the HTTP header limits. Plan is to introduce these in the future plugin versions.

= Info Panels =
In the administration Tools menu, plugin adds DebugPress Info page showing several panels
- PHP Info: full formatted results from phpinfo() function
- OPCache Info: full settings and statistics for the OPCache PHP extension
- MySQL Variables: full MySQL settings retrieved from the database
= Plugin Settings =
The plugin has various options controlling the plugin activation, button integration position, user roles that can see the debugger window, options to attempt overriding WordPress debug flags and options controlling the visibility of optional debugger panels.

= Log into Database =
Debugger popup is visible for the request running in the browser. But there are many requests that are happening in the background (AJAX calls, REST API calls…), and for them, you can’t see errors, call information and other stuff in the debugger. Because of that, DebugPress supports logging of various events into database with the use of ‘coreActivity’ plugin, and it is highly recommended to install and use coreActivity.

Log various debug events into a database with the free plugin: coreActivity Plugin, supporting over 120 events and 10 popular WordPress plugins. DebugPress related events will be logged and available for later analysis, and this includes errors, AJAX calls, and HTTP API calls.

= Documentation and Support =
To get help with the plugin, you can use WordPress.org support forums, or you can use Dev4Press.com support forums.
- Plugin Documentation: DebugPress Website
- Support Forum: Dev4Press Support
Installation

= General Requirements =
- PHP: 7.4 or newer
- Tested with the latest PHP, version 8.3
= WordPress Requirements =
- WordPress: 5.5 or newer
- Tested with the latest WordPress, version 6.5
= Basic Installation =
- Upload folder debugpress to the /wp-content/plugins/ directory
- Activate the plugin through the ‘Plugins’ menu in WordPress
- Plugin settings are available under WordPress ‘Settings’ panel
Frequently Asked Questions

= How I can install this plugin? =
If you are not sure about WordPress plugins installation, here is the quick information: Plugin Installation.

= How can I enable WordPress Debug Mode? =
To enable WordPress debug mode via wp-config.php, check out the article here: WordPress Setup.

= How can I open Debugger popup? =
If you have enabled debugger (for admin side and/or frontend), Debugger is activated via Bug button placed in the WordPress Toolbar or as a float button (depending on the settings). Since version 3.0, you can activate the button via keyboard shortcut, default combination is ctrl+shift+u, but it can be changed in the plugin settings.

= Can I change the size and position of the popup? =
Yes. Once the popup is open, you will find the Layout icon next to the button to close the popup. On the layout panel, you can change the location for the popup, size, modal status and auto activation on page load.

= Where can I configure the plugin? =
Open the WordPress ‘Settings’ menu, there you will find ‘DebugPress’ panel.

Changelog

= 4.0 (2024.11.02) =
- New: tested with WordPress 6.7
- New: tested and compatible with PHP 8.4 RC 3
- New: using composer to load Kint library
- New: various constants for KINT library control
= 3.9.2 (2024.08.23) =
- Fix: one more issue with the access to OPCache status information
= 3.9.1 (2024.08.19) =
- Fix: problem with the Tracker when closure makes a call #08
= 3.9 (2024.05.14) =
- Edit: few more updates and improvements
- Edit: replacement of some native with WordPress functions
- Edit: various small updates and tweaks
- Edit: Kint Pretty Print Library 5.1.1
- Fix: various PHP notices related to PHP 8.1 and newer
= 3.8 (2024.04.24) =
- Edit: few minor tweaks and changes
- Edit: updates to the plugin readme file
- Edit: small changes related to the PHP 8.3 compatibility
- Fix: various PHP notices related to PHP 8.1 and newer
= 3.7 (
WP Version Modifier for CP

DigTek

Allows Spoofing the WP Version to Install and Troubleshoot Plugins and Themes in ClassicPress.

Download

More Info
Allows Spoofing the WP Version to Install Plugins and Themes in ClassicPress.

ChangeLog

= 1.1.0 =
11/20/24
- Apply Blue Haze UI to Settings Page
- Add Code to Insure Save Success Message Displayed
- Code Cleanup
= 1.0.2 =
6/4/24
- Another Save Error Adjustment…
= 1.0.1 =
6/3/24
- Fix Error when Saving on Some Sites
= 1.0.0 =
5/12/24
- Add Multisite Compatibility
- Change Icon to WP Icon
= 0.9.2 =
4/13/24
- Fix Fatal Error if is_plugin_active() not loaded
= 0.9.1 =
4/9/24
- Code Cleaned
= 0.9.0 =
Initial Release Date – 4/4/24

Installation
1. Upload
2. Activate
Updates will be available in the dashboard like any other plugin
- WP Version has a Dashboard Menu to Access the Settings
ClassicPress Directory Integration

ClassicPress

Install and update plugins from ClassicPress directory and keep ClassicPress themes updated.

Download

More Info
Features
- Plugins and themes from ClassicPress Directory now can update as WP.org plugins.
- Plugins from ClassicPress Directory now can be installed using the “Install CP Plugins” menu under “Plugins” menu.
- Themes from ClassicPress Directory now can be installed using the “Install CP Themes” menu under “Appearance” menu.
WP-CLI commands
- Flush transients: wp cpdi flush
Hooks

apply_filters( "cpdi_images_folder_{$plugin}", string $folder )

Filters the folder where we search for icons and banners.
The filtered path is relative to the plugin’s directory.
Default is /images.

Example:
add_filter( 'cpdi_images_folder_' . basename( __DIR__ ), function ( $source ) { return '/assets/images'; } );
Update Manager

Simone Fioravanti

Push updates for your ClassicPress plugins and themes from GitHub or other remote sources.

Download

More Info
Painlessly push updates to your ClassicPress plugin and theme users! Serve updates from GitHub, your own site, or somewhere in the cloud. 100% integrated with the ClassicPress update process; super-slim and performant. Incredibly easy!

With the Update Manager plugin for ClassicPress, developers can push plugin and theme updates out to their end users with ease! This isn’t a fork of a WordPress plugin – this is a brand new plugin built specifically for ClassicPress!

Remote Updates made Easy

No matter where you host your plugin or theme code – GitHub, BitBucket, AWS, or even your own website – the Update Manager plugin makes quick work of pushing updates to your end users. A fantastic tool for plugin and theme developers, agencies, and freelancers!

Simple & Lightweight

The Update Manager only requires that you add a single file to your plugin or theme – and it’s under 30k! There’s no libraries to think about. There’s no huge files to add bloat. There’s no complicated steps to trip you up! And, best of all, your users don’t have to install an extra plugin just to deal with updates.

Complete Integration

The Update Manager plugin is fully integrated with ClassicPress’ core update process. Adding your own icons, banners, and screenshots is as simple as dropping your images into the right directory. When your users click for information about your plugin in their dashboard, the popup windows look fantastic, complete with details, imagery, changelog, reviews…and more! Themes look great, too!

Plugin Integration

To setup a plugin to work with the Update Manager, the following general steps are recommended. This page details each of the steps and describes how to use the plugin going forward.
1. Install and activate the Update Manager plugin on your own site.
2. Add the Update Client file to your own plugin.
3. Create an update endpoint in the Update Manager.
4. Test the endpoint in a browser.
5. Test the update on an actual site.
6. Publish the endpoint.
Install the Update Manager Plugin
1. Install the Update Manager plugin according to the installation instructions.
2. Navigate to Dashboard > Update Manager > Plugins > Add New – this is where you will be managing your plugin updates.
Adding the Update Client file to a Plugin
1. Copy the UpdateClient.class.php file (from the Update Manager plugin) into your plugin’s file structure.
2. Set namespace to a unique value; line 22.
3. Set UPDATE_SERVER to the URL where your Update Manager plugin is installed; line 25.
4. Set USE_DIRECTORY to true to skip loading the class starting from ClassicPress v.2; line 30.
5. Set SECURE_SOURCE to the starting part of the URL of the updated zip file if you want to add an extra layer of security; line 35. See line 236 to understand how check is done.
6. Set UPDATE_TYPE to plugin or theme; line 38.
7. Use require_once('/path/to/UpdateClient.class.php') in your plugin’s primary PHP file to run the update client.
Creating an Update Endpoint for a Plugin
1. Navigate to Dashboard > Update Manager > Plugins > Add New
2. Set the Endpoint Identifier for your plugin; ie, my-plugin-folder/my-plugin-file.php.
3. Add your Plugin Details to the editor; if you have a readme.txt file, you can copy it right in.
4. Optionally, add URLs for any Testing Domains that can receive test updates.
5. Optionally, add contact methods for receiving Notifications of issues.
6. Click Publish to make the update immediately available.
Viewing an Update Endpoint in the Browser

If your update endpoint isn’t working as expected, neither will your update. So, before even testing the update process, it’s a good idea to call up the endpoint in a browser and verify that it looks like valid JSON data. The following steps will allow you to view endpoints in the browser. This is not available for endpoints in Draft status.
1. Navigate to Dashboard > Update Manager > Plugins
2. Hover over any of the listed endpoints and click View Endpoint.
Pushing an Update to all Plugin Users

When you create a new version of your plugin, you’ll need to push it out to your end users. To do this:
1. Navigate to Dashboard > Update Manager > Plugins
2. Click to Edit the particular endpoint.
3. Update the Plugin Details section to reflect the new version’s details.
4. Click to Update the endpoint.
Pushing an Update to Limited Users for Testing Purposes
1. Navigate to Dashboard > Update Manager > Plugins
2. Click to Edit an endpoint.
3. Set the Status to Pending Review.
4. Click to Update the endpoint.
With the plugin in Pending Review status, the update will be made available only to those domains specified in the Testing Domains field. Note that if you are trying to test an update on a plugin that is installed on the same server as the Update Manager plugin, you must still whitelist the domain, otherwise it will not receive the update notification.

Promoting Feedback from your Test Team
1. Navigate to Dashboard > Update Manager > Plugins
2. Click to Edit an endpoint.
3. Add one or more contact methods to the Notifications field.
4. Click to Update the endpoint.
This field accepts multiple email addresses and a single URL, separated by commas. The order is not important. If you supply email addresses, a link will be crafted that prepopulates an email with some basic information. If you supply a URL, it will be used to point the user toward a feedback form, GitHub repo, or wherever. If you supply email(s) and URL, both options will be offered. These links will appear in the test notice that appears in the modal windows.

Pushing Alpha, Beta, and Release Candidate Versions

Semantic versioning is used throughout. You can push updates for alpha, beta, and release candidate versions without any trouble. Let’s say you wanted to run through the basic steps with a version 1.0.0 plugin. You might release a plugin at 1.0.0-alpha. Next, you could bump the version to 1.0.0-beta… and then 1.0.0-rc1, and then 1.0.0-rc2, and then 1.0.0. Each version in that chain succeeds the previous. Here’s the upgrade path, a bit more visually.

1.0.0-alpha < 1.0.0-beta < 1.0.0-rc1 < 1.0.0-rc2 < 1.0.0

Supplemental Note: You can also push sequential updates for a given pre-release (alpha, beta, or RC version). For example, 1.0.0-alpha1 is less than 1.0.0-alpha2 which is less than 1.0.0-alpha3, which is less than…well, you get the idea.

Using Custom Images

You can use your own plugin banner and icon images to improve the end user experience. If you have these images, create an /images/ directory in your plugin and drop them there. They will be automatically discovered and you are free to mix and match any of the following filetypes. If you prefer, you can define your own custom image path; see the filters documentation. If you do not have such images, the default system image will be used for the icon, and your plugin modal windows just won’t have a header graphic. The following are supported:

Normal Images

SVG: icon.svg, banner.svg
PNG: icon-128.png, banner-772x250.png
JPG: icon-128.jpg, banner-772x250.jpg

Retina Images

SVG: icon.svg, banner.svg
PNG: icon-256.png, banner-1544x500.png
JPG: icon-256.jpg, banner-1544x500.jpg

Screenshots

PNG: screenshot-1.png, screenshot-2..png, …
JPG: screenshot-1.jpg, screenshot-2.jpg, …

Note: Screenshots are displayed from lowest to highest, however, they need not be sequentially named. The plugin will find them regardless and will apply the correct caption(s) to the correct image(s).

Theme Integration

To setup a theme to work with the Update Manager, the following general steps are recommended. This page details each of the steps and describes how to use the plugin going forward.
1. Install and activate the Update Manager plugin on your own site.
2. Add the Update Client file to your own theme.
3. Create an update endpoint in the Update Manager.
4. Test the endpoint in a browser.
5. Test the update on an actual site.
6. Publish the endpoint.
Install the Update Manager Plugin
1. Install the Update Manager plugin according to the installation instructions.
2. Navigate to Dashboard > Update Manager > Themes > Add New – this is where you will be managing your theme updates.
Adding the Update Client file to a Theme
1. Copy the UpdateClient.class.php file (from the Update Manager plugin) into your theme’s file structure.
2. Set namespace to a unique value; line 25.
3. Set UPDATE_SERVER to the URL where your Update Manager plugin is installed; line 28.
4. Set UPDATE_TYPE to ‘theme’; line 31.
5. Use require_once('/path/to/UpdateClient.class.php') in your theme’s functions.php file to run the update client.
Creating an Update Endpoint for a Theme
1. Navigate to Dashboard > Update Manager > Themes > Add New
2. Set the Endpoint Identifier for your theme; ie, my-theme-directory-name.
3. Add your Theme Details to the editor; if you have a readme.txt file, you can copy it right in.
4. Optionally, add URLs for any Testing Domains that can receive test updates.
5. Optionally, add contact methods for receiving Notifications of issues.
6. Click Publish to make the update immediately available.
Viewing an Update Endpoint in the Browser

If your update endpoint isn’t working as expected, neither will your update. So, before even testing the update process, it’s a good idea to call up the endpoint in a browser and verify that it looks like valid JSON data. The following steps will allow you to view endpoints in the browser. This is not available for endpoints in Draft status.
1. Navigate to Dashboard > Update Manager > Themes
2. Hover over any of the listed endpoints and click View Endpoint.
Pushing an Update to all Theme Users

When you create a new version of your theme, you’ll need to push it out to your end users. To do this:
1. Navigate to Dashboard > Update Manager > Themes
2. Click to Edit the particular endpoint.
3. Update the Theme Details section to reflect the new version’s details.
4. Click to Update the endpoint.
Pushing an Update to Limited Users for Testing Purposes
1. Navigate to Dashboard > Update Manager > Themes
2. Click to Edit an endpoint.
3. Set the Status to Pending Review.
4. Click to Update the endpoint.
With the theme in Pending Review status, the update will be made available only to those domains specified in the Testing Domains field. Note that if you are trying to test an update on a theme that is installed on the same server as the Update Manager plugin, you must still whitelist the domain, otherwise it will not receive the update notification.

Promoting Feedback from your Test Team
1. Navigate to Dashboard > Update Manager > Themes
2. Click to Edit an endpoint.
3. Add one or more contact methods to the Notifications field.
4. Click to Update the endpoint.
This field accepts multiple email addresses and a single URL, separated by commas. The order is not important. If you supply email addresses, a link will be crafted that prepopulates an email with some basic information. If you supply a URL, it will be used to point the user toward a feedback form, GitHub repo, or wherever. If you supply email(s) and URL, both options will be offered. These links will appear in the test notice that appears in the modal windows.

Pushing Alpha, Beta, and Release Candidate Versions

Semantic versioning is used throughout. You can push updates for alpha, beta, and release candidate versions without any trouble. Let’s say you wanted to run through the basic steps with a version 1.0.0 theme. You might release a theme at 1.0.0-alpha. Next, you could bump the version to 1.0.0-beta… and then 1.0.0-rc1, and then 1.0.0-rc2, and then 1.0.0. Each version in that chain succeeds the previous. Here’s the upgrade path, a bit more visually.

1.0.0-alpha < 1.0.0-beta < 1.0.0-rc1 < 1.0.0-rc2 < 1.0.0

Supplemental Note: You can also push sequential updates for a given pre-release (alpha, beta, or RC version). For example, 1.0.0-alpha1 is less than 1.0.0-alpha2 which is less than 1.0.0-alpha3, which is less than…well, you get the idea.

Transient Inspector

Dashboard > Update Manager > Transients

The Update Manager plugin contains functionality that allows you to view and delete the transients related to plugin and theme updates. This functionality provides a reliable method of forcing an update check, regardless of when the last check took place. Note that this functionality reveals all update data, so, even if a plugin or theme is not integrated with the Update Manager plugin, its update data can be viewed (and deleted) here.

Inspecting Transient Data

Clicking the Plugin Update Data or Theme Update Data tabs will reveal the data stored in your database related to plugin and theme updates. The data is only presented for informational purposes and is not editable on these screens.

Previewing Updates

Clicking the Update Data tab will show plugin and theme update information on the same screen and in a more reader-friendly format.

Delete Plugin Transients

Clicking the text link to delete Plugin transients will delete the data stored in the options table as _site_transient_update_plugins. With this transient data deleted, the system will check for plugin updates on the next page load regardless of when the last update check took place.

Delete Theme Transients

Clicking the text link to delete Theme transients will delete the data stored in the options table as _site_transient_update_themes. With this transient data deleted, the system will check for theme updates on the next page load regardless of when the last update check took place.

Delete Both Transients

Clicking the text link to delete Both transients will delete the data stored in the options table for both _site_transient_update_plugins and _site_transient_update_themes. With this transient data deleted, the system will check for both plugin and theme updates on the next page load regardless of when the last update took place.

Processing Incoming Requests

To work with the data received from incoming requests, the following filter can be added to a utility plugin. This might be used for tracking installations or adding/removing values to/from the request before querying the endpoint for data. This filter accepts 1 argument, $request. Replace {component-type} with either plugin or theme, depending on the type of request you are trying to filter.
```
function some_function_name($request) {

     // Do your processing here.

    // Return the processed request.
    return $request;
}
add_filter('codepotent_update_manager_filter_{component-type}_request', 'some_function_name');
```
Processing Outgoing Responses

When a request is received by the Update Manager plugin, the relevant plugin (or theme) data is assembled and passed back as a response to the calling site. This filter allows final processing of that data before it is returned to the calling site. This filter accepts 2 arguments, data and request and returns the possible-amended data.
```
function some_function_name($data, $request) {

     // Do your processing on $data here.

    // Return the processed data.
    return $data;
}
add_filter('codepotent_update_manager_filter_parsed_component_data', 'some_function_name', 10, 2);
```
Active Installations

The Update Manager plugin does not track or know how many active installations there are of any given plugin. If you are otherwise tracking those numbers, you can filter them into the remote modal windows by adding the following filter to a utility plugin. The filter accepts only uses the first of the two arguments, $number. Replace {identifier} with your plugin identifier, ie, my-plugin-dir/my-plugin-file.php.
```
function some_function_name($number, $identifier) {
    return $number;
}
add_filter('codepotent_update_manager_{identifier}_active_installs', 'some_function_name', 10, 2);
```
Admin Menu

Position To change the admin menu item’s position, this filter can be added to a utility plugin. See also the following table of menu position values.
```
function some_function_name($position) {
    return 22;
}
add_filter('codepotent_update_manager_menu_pos', 'some_function_name');
```
Menu Item Positions 1: Top of menu 2: below Dashboard 5: below Posts 10: below Media 20: below Pages 25: below Comments 60: below first separator 65: below Plugins 70: below Users 75: below Tools 80: below Settings 100: below second separator null: below Comments, in natural order; default

Plugin Images Path & URL

These filters can be used if you already have a particular directory schema under which your plugin’s images are stored. These filters would be used in your own plugin.

Plugin-specific filters

Those new filters prevents plugins from accidentally overwrite other’s path.
```
function new_custom_image_path($path) {
	return plugin_dir_path(__FILE__).'beautifulimages';
}
add_filter('codepotent_update_manager_{plugin-slug}_image_path', 'new_custom_image_path');

function new_custom_image_url($url) {
	return plugin_dir_url(__FILE__).'beautifulimages';
}
add_filter('codepotent_update_manager_{plugin-slug}_image_url', 'new_custom_image_url');
```
Global filters (deprecated since version 2.3.0)

Note that you should always check for the right plugin slug before altering the path, as shown in the examples here. Be sure to replace {plugin-slug} with the slug of your own plugin.
```
function my_custom_image_path($path) {
    if (strpos($path, {plugin-slug}) !== false) {
        $path = '/path/to/your-site/wp-content/plugins/your-plugin-name/assets/images';
    }
    return $path;
}
add_filter('codepotent_update_manager_image_path', 'my_custom_image_path');

function my_custom_image_url($url) {
    if (strpos($path, {plugin-slug}) !== false) {
        $path = 'https://yoursite.com/wp-content/plugins/your-plugin-name/assets/images';
    }
    return $path;
}
add_filter('codepotent_update_manager_image_url', 'my_custom_image_url');
```
Filter Notification

Email Properties If you are using the notification features for endpoints to allow your testers to contact you with feedback, you can filter the default subject and body of the email message with the following filters.
```
function some_function_name($subject) {
    return 'Some custom subject line';
}
add_filter('codepotent_update_manager_notification_email_subject', 'some_function_name');

function some_function_name($body) {
    $body = 'A line followed by two blank lines.'."nn";
    $body .= 'Another line...';
    return $body;
}
add_filter('codepotent_update_manager_notification_email_body', 'some_function_name');
```
Footer Credit

For extension authors, this filter allows for a credit link to be appended to the Code Potent footer text. This filter accepts a single argument, $text, which is an empty string, by default. Note that all HTML is stripped, except for the tag. The URLs can be as long as needed, but, the visible text and links may be truncated at 50 characters. This filter is for adding a credit link, not for marketing text and upsells; misusing this feature will cause it to be removed.
```
function some_function_name($text) {
    return 'Featuring <a href="#">My Extension</a> by <a href="#">Author Name</a>';
}
add_filter('codepotent_update_manager_extension_footer_{your-slug-here}', 'some_function_name');
```
Request body

This filter allows to add fields to the request made by the UpdateClient.class.php. It’s useful for plugin authors that wants to pass data to some Update Manager extension. For example Stats for Update Manager uses it to allow plugin authors to give their users the choice to opt-in or out from their site being counted usage in statistics.
```
function some_function_name($body) {
	if( 'no' === get_option( 'my-slug-usage-statistics' ) ) {
		$body['sfum'] = 'no-log';
	}
	return $body;
}
add_filter('codepotent_update_manager_filter_{your-slug-here}_client_request', 'some_function_name');
```
Manual Installation
- Download the zip file to your local computer
- Login to your ClassicPress website.
- Navigate to Dashboard > Plugins > Add New > Upload Plugin
- Upload the zip file to your site
- Click to Install the plugin
- Click to Activate the plugin