Piklist checker

Piklist Checker message

Use the Piklist checker when creating plugins that require Piklist. The Piklist Checker makes it easy for you to notify users from your plugin or theme when Piklist is not active. Since your plugin or theme requires Piklist, not having Piklist installed and activated would provide an unpleasant user experience. Piklist Checker is designed to alleviate that.

If the user attempts to activate a Piklist plugin or theme, without activating Piklist first, they will get a message notifying them the plugin was deactivated and instructions on how to get Piklist.

Usage

Piklist checker is designed to be easy to include in your plugin or theme.

Include the Piklist Checker file in your Piklist plugin or theme. You can always get the most up-to-date version of Piklist Checker at WordPress.org.

Plugin

Add the following to your plugin. Notice the checker code is wrapped in a function that hooks to the init action.

Theme

If you’re using Piklist in your theme, this code should go in the functions.php file. Notice the added parameter after __FILE__:

Example

You can find an example of implementing the Piklist Checker in the WordPress Helpers plugin.

Have ideas for improving the documentation?

This documentation is a community effort. Please create an issue or pull request to help!

Improve this page