Download the PHP package voceconnect/wp-contextual-help without Composer
On this page you can find all versions of the php package voceconnect/wp-contextual-help. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download voceconnect/wp-contextual-help
More information about voceconnect/wp-contextual-help
Files in voceconnect/wp-contextual-help
Package wp-contextual-help
Short Description WordPress plugin that allows a developer to easily extend the contextual help dropdown content area in WordPress
License GPLv2+
Informations about the package wp-contextual-help
Please note: This plugin is no longer being actively maintained or supported.
WP Contextual Help
Contributors: kevinlangleyjr, voceplatforms, Mte90
Tags: contextual, help
Requires at least: 3.3
Tested up to: 4.1
Stable tag: 1.0.2
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
Allows a developer to easily extend the contextual help dropdown content area in WordPress.
Description
Adds helper functionality to easily add to the WP Contextual Help throughout the admin of a WordPress site.
Installation
As standard plugin:
See Installing Plugins.
As theme or plugin dependency:
After dropping the plugin into the containing theme or plugin, add the following:
As a composer dependency
Add the following to your composer.json required dependencies
Usage
When you register a tab you have a few different options as far as what content is displayed there.
If you provide a callback argument in the tab args, that will take precedence and the plugin will not look for any HTML files within the help-docs directory.
If you provide a file argument in the tab args, the plugin will look for that file specifically and if it does not exist will output a warning message in place of the content to notify the developer that the specified help document does not exist.
If no file or callback argument is passed into the tab args, by default the plugin will look for a file with the same name as the id of the tab. So for it would look for within the help docs directory.
HTML Help Docs
All help docs should either reside within the directory and all images within the
You can use the filter to change the directory for the HTML files and the filter to change the base URL for the images. Within your help documentation we use the variable as a placeholder for the image URL which is then replaced before rendering with the value provided from the filter or defaults to the default help docs image directory.
Registering a tab
Help tabs are registered using the method.
Parameters
- (string) - String to be used as the ID for the help tab
- (string) - Title to display to the user within the tab
- (array) - An array of options for the help tab
- (string, array) - Page(s) to enable the help tab
- (string, array) - Limit the tab to only display on these specific post types
- (string) - HTML file to read and output within the tab
- (boolean) - Default: False - Apply wpautop to the loaded HTML file
-
- If a user would rather a custom callback instead of the autoloading of a HTML file, this is where that would be applied
Example
Changelog
Please refer to full changelog at https://github.com/voceconnect/wp-contextual-help/releases.