Admin Notes WP

Description

Admin Notes WP allows you to embed instructional ‘how to’ videos and other embeddable media from major platforms directly in the WordPress admin help tabs. Useful, instructional videos can be included on the relevant admin pages to help website admin users learn how your plugins and theme work.

For more quick videos on the features of Admin Notes WP visit the Web Rockstar YouTube channel

Other features include:

  • Along with embedded media, rich text can also be included in help tab content to explain how features work
  • Custom notices can be placed on any admin screen, communicating important information about the page and how it works
  • The custom admin footer text provide a subtle and unobtrusive information about about the company or person who setup/created the site
  • Some users are not aware of the WordPress help tab. A bounce animation (similar to MacOS icon bounce) displays once per user until clicked to help them discover it for the first time
  • Determining what ‘screen id’ a help tab should display on can be tricky. The Admin Screen ID Identifier Tool allows you to copy the screen id with the click of a button
  • A default WordPress install comes with many built in help tabs that may not be relevant for your website and cause confusion. These default help tabs can be hidden if desired.

Components that are not relevant for your unique needs can be easily deactivated, removing them from the admin menus.

Useful Third Party Plugins and Other Techniques

The following are some additional third party plugins and useful techniques which can nicely enhance the functionality
of Admin Notes WP.

Post Expirator

The Post Expirator can allow you to set Help Tab and Notice
posts to expire (not display) after a certain time or date.

Post Dating Posts

Setting the Help Tab or Notice post published date in the future will cause that post to only start appearing once that
date and time has been reached.

User Role Editor

The User Role Editor plugin allows you to manage the user capabilities
associated with Admin Notes WP. Refer to the Frequently Asked Questions section for the full list.

Screenshots

  • The Global Help Tab is separate from the Help Tab post type. This special help tab appears on every admin page.
  • The admin footer text is a great, subtle way to leave your 'calling card'. It can be used to briefly state the company or individual that created the site and contact information.
  • The Screen ID helper link in the toolbar makes identifying WordPress admin screen ids very easy
  • The main Admin Notes WP settings page
  • The Help Tab post type 'edit post' admin page
  • The Help Tab post type display
  • The Notice post type 'edit post' admin page
  • The Notice post type display
  • To help with discoverability of the help tab (some users are not aware of it), a bounce animation (similar to the MacOS icon bounce) can be enabled to occur once per user

Installation

After plugin activation go to /wp-admin/options-general.php?page=crb_carbon_fields_container_wp_admin_notes.php to configure
Admin Notes WP to your needs. This link is available in Settings > Admin Notes WP.

FAQ

Screen ID Helper Tool Not Displaying

The ‘Help Tab’ or ‘Notice’ post type must be enabled in order for the ‘Screen ID’ header toolbar link to display.
‘Help Tab’ and ‘Notice’ post type enabling/disabling can be managed on the settings page in Settings > Admin Notes WP Settings.

How do I find the screen id I want to display a help tab or notice on?

The easiest way to obtain the screen id for the desired admin page is to use the ‘Screen ID’ helper tool. This is located
in the admin header toolbar. Just visit the desired admin page you would like the notice or help tab to appear on.
Click on the submenu link and the screen id will automatically be copied to your clipboard. Refer to the screenshot
section to see what this looks like.

User Capabilities

In order to access the Admin Notes WP settings page, the user must have the manage_options capability. It should be
noted that the built in ‘Administrator’ role has this capability. In addition, the ‘Administrator’ role is also given the
following capabilities related to the ‘Help Tab’ and ‘Notice’ post type are also added to the Administrator role:

  • edit_wpan_help_tab
  • edit_wpan_help_tabs
  • edit_others_wpan_help_tabs
  • publish_wpan_help_tabs
  • read_wpan_help_tab
  • read_private_wpan_help_tabs
  • delete_wpan_help_tab
  • edit_published_wpan_help_tabs
  • delete_published_wpan_help_tabs

  • edit_wpan_notice

  • edit_wpan_notices
  • edit_others_wpan_notices
  • publish_wpan_notices
  • read_wpan_notice
  • read_private_wpan_notices
  • delete_wpan_notice
  • edit_published_wpan_notices
  • delete_published_wpan_notices

You can assign these capabilities to other user roles if desired. This can be done directly in your website code (https://developer.wordpress.org/plugins/users/roles-and-capabilities/#adding-capabilities)
or with a third party plugin like User Role Editor.

Screen ID ‘copy to clipboard’ link is not working

The WordPress Admin must be viewed under SSL (the https:// URL) for the ‘copy to clipboard’ functionality to work.

Help Tab not Appearing

If you are using the WordPress Block Editor, the post edit page does not support help tabs. It will not display on that
particular page.

Reviews

There are no reviews for this plugin.

Contributors & Developers

“Admin Notes WP” is open source software. The following people have contributed to this plugin.

Contributors

Translate “Admin Notes WP” into your language.

Interested in development?

Browse the code, check out the SVN repository, or subscribe to the development log by RSS.

Changelog

1.1.0

  • Rich text editor to Help Tab post type and Global help tab
  • auto render URLs as clickable links
  • improved field instructions
  • ability to include iframes (videos) in help tab content
  • improved i18n of field text

1.0.0

  • Initial Release