https://github.com/wpbp/pointerplus

Simple pointers for WP Admin
https://github.com/wpbp/pointerplus

wordpress wordpress-php-library

Last synced: about 1 month ago
JSON representation

Simple pointers for WP Admin

• Host: GitHub
• URL: https://github.com/wpbp/pointerplus
• Owner: WPBP
• License: gpl-3.0
• Created: 2015-01-16T15:14:17.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2022-09-13T11:02:17.000Z (over 2 years ago)
• Last Synced: 2024-10-30T00:54:59.022Z (2 months ago)
• Topics: wordpress, wordpress-php-library
• Language: PHP
• Size: 48.8 KB
• Stars: 20
• Watchers: 2
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# PointerPlus

[![License](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](http://www.gnu.org/licenses/gpl-3.0)

![Downloads](https://img.shields.io/packagist/dt/wpbp/pointerplus.svg)    

Super pointer creation for WP Admin

## Install

`composer require wpbp/pointerplus:dev-master`

## Features

* Pointer autoposition by selector (WP-Pointer API)

* Remember the Pointer  (WP-Pointer API)

* Show by Post Type

* Show by page (ex: users.php)

* Custom dashicon (https://developer.wordpress.org/resource/dashicons)

* Hide feature

* Custom button with JS callback

* Custom PHP Code to execute at loading of the page

* Reset the pointer by prefix (by user id)

* Wait the available selector

* Create a wizard-like system

## Example

```php

$pointerplus = new PointerPlus( array( 'prefix' => 'your-pointer-domain' ) );

// With this line of code you can reset all the pointer with your prefix

// $pointerplus->reset_pointer();

function custom_initial_pointers( $pointers, $prefix ) {

	/*

	  Default parameters:

	  $defaults = array(

	  'class' => 'pointerplus',

	  'width' => 300, //fixed value

	  'align' => 'middle',

	  'edge' => 'left',

	  'post_type' => array(),

	  'pages' => array(),

	  'next' => 'the id of the pointer to jump on Next button click',

	  // Or a custom js solution

	  'jsnext' => '' //empty [t = pointer instance, $ = jQuery]

	  'phpcode' => function() //executed on admin_notices action

	  'show' => 'open' //default,

	  'next' => 'id' // On close the pointer show to that pointer

	  );

	 */

	return array_merge( $pointers, array(

		$prefix . '_settings' => array(

			'selector' => '#menu-settings',

			'title' => __( 'PointerPlus Test', 'your-pointer-domain' ),

			'text' => __( 'The plugin is active and ready to start working.', 'your-pointer-domain' ),

			'width' => 260,

			'icon_class' => 'dashicons-admin-settings',

			'jsnext' => "button = jQuery('" . __( 'Open Popup' ) . "');

                    button.bind('click.pointer', function () {

                        t.element.pointer('close');

                    });

                    return button;",

			'phpcode' => custom_phpcode_thickbox()

		),

		$prefix . '_posts' => array(

			'selector' => '#menu-posts',

			'title' => __( 'PointerPlus for Posts', 'your-pointer-domain' ),

			'text' => __( 'One more pointer.', 'your-pointer-domain' ),

			'post_type' => array( 'post' ),

			'icon_class' => 'dashicons-admin-post',

			'width' => 350,

		),

		$prefix . '_pages' => array(

			'selector' => '#menu-pages',

			'title' => __( 'PointerPlus Pages', 'your-pointer-domain' ),

			'text' => __( 'A pointer for pages.', 'your-pointer-domain' ),

			'post_type' => array( 'page' ),

			'icon_class' => 'dashicons-admin-post'

		),

		$prefix . '_users' => array(

			'selector' => '#menu-users',

			'title' => __( 'PointerPlus Users', 'your-pointer-domain' ),

			'text' => __( 'A pointer for users.', 'your-pointer-domain' ),

			'pages' => array( 'users.php' ),

			'icon_class' => 'dashicons-admin-users'

		),

		$prefix . '_settings_tab' => array(

			'selector' => '#show-settings-link',

			'title' => __( 'PointerPlus Help', 'your-pointer-domain' ),

			'text' => __( 'A pointer with action.', 'your-pointer-domain' ),

			'edge' => 'top',

			'align' => 'right',

			'icon_class' => 'dashicons-welcome-learn-more',

			'next' => $prefix . '_contextual_tab'

		),

		$prefix . '_contextual_tab' => array(

			'selector' => '#contextual-help-link',

			'title' => __( 'PointerPlus Help', 'your-pointer-domain' ),

			'text' => __( 'A pointer for help tab.
Go to Posts, Pages or Users for other pointers.', 'your-pointer-domain' ),

			'edge' => 'top',

			'align' => 'right',

			'icon_class' => 'dashicons-welcome-learn-more',

			'show' => 'close'

		)

			) );

}

// Your prefix

add_filter( 'your-pointer-domain-pointerplus_list', 'custom_initial_pointers', 10, 2 );

function custom_phpcode_thickbox() {

	add_thickbox();

	echo '


			


				 This is my hidden content! It will appear in ThickBox when the link is clicked.

				 

			

		
';

}

```