This plugin will allow creation of admin pointers on any screen in the WordPress admin area, or any front end page, or on all pages. It creates a custom post type called Pointers to store information. You need to add the following info to make it work:
- Title – the part in the blue title bar
- Main content area
- Pointer id – A unique id so that it can be tracked in the WP DB as dismissed
- Screen (or Page/Post ID) – What page/screen it should appear on (if in admin) or what is the post ID (if showing on the front end). OR you have the ability to show on all admin or all front end pages (using ALL_ADMIN or ALL_FRONT)
- Target – CSS id or class we want the pointer to attach to on the screen or post above
- Position Edge – Which edge should be adjacent to the target? (left, right, top, or bottom)
- Position Align – How should the pointer be aligned on this edge, relative to the target? (top, bottom, left, right, or middle)
- (OPTIONAL) Nudge Horizontal – How much should we nudge the pointer horizontally? (Value in pixels. ex: -50, from edge value above, only works if edge above is left or right)
- (OPTIONAL) Nudge Vertical – How much should we nudge the pointer vertically? (Value in pixels. ex: -50, from align value above, only works if align above is top or bottom)
- (OPTIONAL) Z-index – What should the depth of the pointer be along the z-axis (in case you want some of them to sit higher/lower than others or higher/lower than other elements on the page)
EXAMPLE:
Let’s say I want to add a pointer on the edit plugin page that tells a user to notice which plugin they are editing. I would use:
- “Which Plugin am I Editing?”
- “This is the file you are editing, duh”
- “ss_editplugs”
- “plugin-editor”
- “.fileedit-sub”
- “top”
- “right”
- “-50”
- “-5”
- “50000”
NOTE: This will only work for logged in users, whether on front end or back end.
NOTE: I also have a plugin that does help tabs, if you are interested in that one you can find it here: https://wordpress.org/plugins/better-admin-help-tabs/
This plugin leverages the great work done by others here:
For configuring metaboxes on the custom post type:
https://github.com/WebDevStudios/CMB2
For base class and code to allow pointers to display properly:
https://gist.github.com/brasofilo/6947539
Download & install the zip archive
The plugin package installer can be downloaded from the WP2E project tab called “code”.
1 – Select the version to download if this option is available otherwise the “latest” version of the main plugin will be used.
2 – After downloading the zip archive install the plugin package installer in you local environment and activate the script from the plugin list.
3 – Under the section “Plugins” of the admin dashboard you should see a new “Dependencies & Licenses” link. Follow the instructions from this panel to finalize the installation of the missing dependencies.
-
- Give a name to your project
-
- Download the Installer Package
-
- Install & activate the plugin locally
-
- Install the suggested dependencies
Tips: Use the WP2E panel to add/suggest new dependencies to the local installation. Press F5 in the list of dependencies if the changes are not displayed right away.