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 box

Unlike metaboxes, the box can be rendered via code and will enqueue assets on the page where its declared. A box also has save on a submission. Data is saved as an array structure based on the tree of child objects.

uix\ui\uix
Extended by uix\data\data
Extended by uix\ui\panel
Extended by uix\ui\box implements uix\data\save, uix\data\load

Direct known subclasses

uix\ui\page

Namespace: uix\ui
Package: uix\ui
Author: David Cramer
Located at classes/uix/ui/box.php

Methods summary

public
# init( )

Sets the controls data

Sets the controls data

Since

1.0.0

See

\uix\uix

Overrides

uix\ui\uix::init
public
# set_assets( )

set metabox styles

set metabox styles

Since

1.0.0

See

uix\ui\uix

Overrides

uix\ui\panel::set_assets
public
# save_data( )

save data to database

save data to database

Since

1.0.0

Implementation of

uix\data\save::save_data()
public mixed
# load_data( )

Get data

Get data

Returns

mixed
$data Requested data of the object

Since

1.0.0

Implementation of

uix\data\load::load_data()
public array
# get_data( )

Get Data from all controls of this section

Get Data from all controls of this section

Returns

array
Array of sections data structured by the controls

Since

1.0.0

See

\uix\load

Overrides

uix\ui\panel::get_data
public string
# store_key( )

get the objects data store key

get the objects data store key

Returns

string
$store_key the defined option name for this UIX object

Since

1.0.0

Implementation of

uix\data\save::store_key()
public
# set_attributes( )

Sets the wrappers attributes

Sets the wrappers attributes

Since

1.0.0

Overrides

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

Render the box

Render the box

Returns

string
HMTL of rendered page

Since

1.0.0

Overrides

uix\ui\panel::render
public string
# render_header( )

Render the page

Render the page

Returns

string
HMTL of rendered page

Since

1.0.0

Methods inherited from uix\ui\panel

child_count(), description(), enqueue_active_assets(), is_section_object(), label(), navigation(), panel_section(), render_template(), set_data(), wrapper_class_names()

Methods inherited from uix\data\data

setup()

Methods inherited from uix\ui\uix

__call(), __construct(), actions(), base_color(), build_attributes(), enqueue_core(), id(), is_active(), process_child(), process_children(), register(), render_children(), set_url()

Properties summary

public string $type

The type of object

The type of object

Since

1.0.0
# 'box'

Properties inherited from uix\data\data

$data

Properties inherited from uix\ui\uix

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

UIX Documentation API documentation generated by ApiGen