rawcreative / wp-help-pointers

Class for registering and using custom WP Help Tooltips in WP 3.3+

WP Help Pointers

Class for registering and using custom WP Help Tooltips in WP 3.3+

Modified from: http://wp.tutsplus.com/tutorials/integrating-with-wordpress-ui-admin-pointers/

How to Use:

In your functions.php file: require_once('class.wp-help-pointers.php');

Pointers are defined in an associative array and passed to the class upon instantiation. This is done by hooking into 'admin_enqueue_scripts'

	add_action('admin_enqueue_scripts', 'myHelpPointers');
	function myHelpPointers() {
	   //First we define our pointers 
	   $pointers = array(
	                    array(
	                        'id' => 'xyz123',   // unique id for this pointer
	                        'screen' => 'page', // this is the page hook we want our pointer to show on
	                        'target' => '#element-selector', // the css selector for the pointer to be tied to, best to use ID's
	                        'title' => 'My ToolTip',
	                        'content' => 'My tooltips Description',
	                        'position' => array( 
	                                           'edge' => 'top', //top, bottom, left, right
	                                           'align' => 'middle' //top, bottom, left, right, middle
	                                           )
	                        )
	                     // more as needed
	                     );
	   //Now we instantiate the class and pass our pointer array to the constructor 
	   $myPointers = new WP_Help_Pointer($pointers);

wp-help-pointers's Issues

Licensing for wp-help-pointers

What's the License for this? Are you interested in making it a package here: https://github.com/wpplex ?

register_pointers causing a PHP Notice when on a page with no pointers

Line 82 reads:

$this->pointers = $pointers;

If there are no pointers set for the currently viewed page, this will show a PHP Notice that the variable $pointers is undefined.

This can be easily fixed by including $pointers = NULL; on line 61, right after the function starts. This way if there are no pointers, the variable will still be defined and thus no longer give the notice.

more as needed?

Hello, Thanks for whipping this up BTW.
When I ad another array where the comment says //more as needed I get an error... What am I doing wrong?