Class AdminPageFramework_PointerToolTip

Displays pointer tool boxes in the admin area.

This is useful when you want to direct users' attentions to a certain part of a page.

Usage

Instantiate this class by passing arguments to the constructor. For arguments, see the __construct() method below.

Example

new AdminPageFramework_PointerToolTip(
    'post',   // screen id or page slug
    'xyz140', // unique id for the pointer tool box
    array(    // pointer data
        'target'    => '#change-permalinks',
        'options'   => array(
            'content' => sprintf( '<h3> %s </h3> <p> %s </p>',
                __( 'Title' ,'plugindomain'),
                __( 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.', 'plugindomain' )
            ),
            'position'  => array( 'edge' => 'top', 'align' => 'middle' )
        )
    )
);

Package: AdminPageFramework\Utility
Copyright: Copyright (c) 2013-2022, Michael Uno
Author: Michael Uno
Since: 3.7.0
Extends: AdminPageFramework_FrameworkUtility
Image: http://admin-page-framework.michaeluno.jp/image/utility/pointer_tool_tip.png
Located at utility/pointer_tool_tip/AdminPageFramework_PointerToolTip.php

Methods summary

`public`	# `__construct( array\|string $asScreenIDs, string $sPointerID, array $aPointerData )` Sets up hooks and properties. Parameters `$asScreenIDs` `array\|string` $asScreenIDs Screen IDs or page slug. `$sPointerID` `string` $sPointerID A unique pointer ID. `$aPointerData` `array` $aPointerData The pointer data. Arguments `target` - (string) a selector for the target element that the pointer tooltip points to. e.g. `#my-selector-id`, `.my-selector-class` `options` - (array) an array holding additional option arguments. `content` - (string) The contents of the pointer tooltip box. `position` - (array) An array holding the position information with the following arguments. e.g. `array( 'edge' => 'top', 'align' => 'middle' )` `edge` - the edge position the target element is attached to. Accepts `left`, `right`, `top`, or `bottom`. `align` - the alignment position that the target element is attacked to. Accepts `top`, `bottom`, `left`, `right`, or `middle`. Since 3.7.0 See https://codex.wordpress.org/Plugin_API/Admin_Screen_Reference

Magic methods summary

Properties summary

`public mixed`	`$sPointerID`	# Stores the pointer tool box id for the class instance.
`public mixed`	`$aPointerData`	# Stores the pointer tool box definition for the class instance.
`public array`	`$aScreenIDs`	# User set screen IDs. Accepts APF page slugs.

Packages

Classes

Resources

Class AdminPageFramework_PointerToolTip

Usage

Example

Methods summary

Parameters

Arguments

Since

See

Magic methods summary

Properties summary

Related