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 notice

UIX Notice. Handles displaying of admin notices.

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

Methods summary

public
# setup( )

setup notice

setup notice

Since

1.0.0

Overrides

uix\data\data::setup
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( )

Render the panel

Render the panel

Returns

string
HTML of notice

Since

1.0.0
public string|null
# dismiss( )

Render a dismiss button

Render a dismiss button

Returns

string|null
HTML of dismiss button

Since

1.0.0
public
# set_dismissable( )

Sets the wrappers class names

Sets the wrappers class names

Since

1.0.0
public
# set_state( )

Sets the wrappers class names

Sets the wrappers class names

Since

1.0.0

Methods inherited from uix\data\data

get_data(), set_data()

Methods inherited from uix\ui\uix

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

Properties summary

public string $type

The type of object

The type of object

Since

1.0.0
# 'notice'
public array $classes

The wrapper elements class names

The wrapper elements class names

Since

1.0.0
# array( 'uix-notice', 'notice' )
public array $attributes

The wrapper elements main attributes

The wrapper elements main attributes

Since

1.0.0
#
public string $state

The state type of the notice ( warning, error, success )

The state type of the notice ( warning, error, success )

Since

1.0.0
# 'notice'

Properties inherited from uix\data\data

$data

Properties inherited from uix\ui\uix

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

UIX Documentation API documentation generated by ApiGen