UIX Documentation
  • Namespace
  • Class
  • Tree

Namespaces

  • None
  • uix
    • data
    • ui
      • control

Classes

  • box
  • control
  • footer
  • grid
  • header
  • help
  • metabox
  • modal
  • notice
  • page
  • panel
  • post_type
  • repeat
  • section
  • uix

Class help

UIX Help. Handles displaying of contextual help items in admin

uix\ui\uix
Extended by uix\ui\help
Namespace: uix\ui
Package: uix\ui
Author: David Cramer
Located at classes/uix/ui/help.php

Methods summary

protected
# actions( )

Set hooks on when to load the notices

Set hooks on when to load the notices

Since

1.0.0

Overrides

uix\ui\uix::actions
public string
# render( )

Add defined contextual help to current screen

Add defined contextual help to current screen

Returns

string
HTML of rendered object

Since

1.0.0
public
# is_active( )

Determin if a help is on this page

Determin if a help is on this page

Since

1.0.0

Overrides

uix\ui\uix::is_active

Methods inherited from uix\ui\uix

__call(), __construct(), base_color(), build_attributes(), enqueue_active_assets(), enqueue_core(), id(), init(), process_child(), process_children(), register(), render_children(), set_assets(), set_attributes(), set_url(), setup()

Properties summary

public string $type

The type of object

The type of object

Since

1.0.0
# 'help'

Properties inherited from uix\ui\uix

$assets, $attributes, $child, $parent, $scripts, $slug, $struct, $styles, $url

UIX Documentation API documentation generated by ApiGen