MasterPress 1.3.1 is now available
MasterPress 1.3.1 is a compatibility release for PHP 8 and WordPress 5.7. It still remains backwards compatible with older PHP versions.
WOOF_HTML
A utility class for generating HTML code, used heavily throughout the MasterPress UI, but also handy for theme development.
List of Methods
Properties
-
attr( String $key, $val )String
Creates an attribute key-value pair for use in HTML.
-
checked_attr( Boolean $test )String
Generates the checked=”checked” attribute for a checkbox or radio control, based on a boolean test passed to the method.
-
close( $tag )String
Generates a close tag for the given tag name.
-
disabled_attr( Boolean $$test )String
Returns the HTML disabled attribute if the specified $test is true.
-
input_checkbox_group( String $name, String $id, Array $items, Array / String $vals, String $item_open, String $item_close, Boolean $disabled = false )String
Generates a group of checkboxes and their associated labels.Notes:The items associative array passed to this method should be keyed by the labels used, with the values being the associated value in the checkbox.
-
input_radio_group( String $name, String $id, Array $items, String $val, String $item_open, String $item_close, Boolean $disabled = false )String
Generates a group of radio buttons and their associated labels.Note: The items array passed to this method is an associative array of the values in each radio button keyed by the labels used.
-
open( String $tag, Arguments $attr, Boolean $self_close = false, Boolean $empty_attr = false )String
Generates the opening tag for a given tag name. .
-
option_values( String $str, String $empty_label = "", Boolean $detect_groups = false )Array
Converts the format of choices and choice groups accepted by the Drop Down List and List Box field types into an array which can then be fed into the WOOF_HTML::options method.
-
options( Array $options, Array / String $vals, Array $options_attr )String
Generates the set of option tags for an HTML select.
-
pos_class( Integer $pos, Integer $count, String $prefix = "", String $fc = "first", String $lc = "last" )String
Used to output a special class for the first and last items in an indexed list.
-
pos_class_1( Integer $pos, Integer $count, String $prefix = "", String $fc = "first", String $lc = "last" )String
Used to output a special class for the first and last items in an indexed list, assuming a 1-based index.
-
readonly_attr( Boolean $$test )String
Returns the HTML readonly attribute if the specified $test is true.
-
select( Arguments $attr, Array $options, Array / String $vals, Array $options_attr )String
Generates the code for an HTML select. Important: the $options parameter is passed into the WOOF_HTML::options method, so please refer to that method for the supported formats.
-
selected_attr( Boolean $test )String
Generates the selected=”selected” attribute for an HTML select, based on a boolean test passed to the method.
-
tag( String $tag, Arguments $attr, String $text = null, Boolean $empty_attr = false )String
Generates an enitre HTML tag with opening tag, text, and closing tag for a given tag name.
Utility
-
strip_whitespace( $html )String
Removed the whitespace between tags from an HTML string. .
-
attr( String $key, $val )String
Creates an attribute key-value pair for use in HTML.
-
checked_attr( Boolean $test )String
Generates the checked=”checked” attribute for a checkbox or radio control, based on a boolean test passed to the method.
-
close( $tag )String
Generates a close tag for the given tag name.
-
disabled_attr( Boolean $$test )String
Returns the HTML disabled attribute if the specified $test is true.
-
input_checkbox_group( String $name, String $id, Array $items, Array / String $vals, String $item_open, String $item_close, Boolean $disabled = false )String
Generates a group of checkboxes and their associated labels.Notes:The items associative array passed to this method should be keyed by the labels used, with the values being the associated value in the checkbox.
-
input_radio_group( String $name, String $id, Array $items, String $val, String $item_open, String $item_close, Boolean $disabled = false )String
Generates a group of radio buttons and their associated labels.Note: The items array passed to this method is an associative array of the values in each radio button keyed by the labels used.
-
open( String $tag, Arguments $attr, Boolean $self_close = false, Boolean $empty_attr = false )String
Generates the opening tag for a given tag name. .
-
option_values( String $str, String $empty_label = "", Boolean $detect_groups = false )Array
Converts the format of choices and choice groups accepted by the Drop Down List and List Box field types into an array which can then be fed into the WOOF_HTML::options method.
-
options( Array $options, Array / String $vals, Array $options_attr )String
Generates the set of option tags for an HTML select.
-
pos_class( Integer $pos, Integer $count, String $prefix = "", String $fc = "first", String $lc = "last" )String
Used to output a special class for the first and last items in an indexed list.
-
pos_class_1( Integer $pos, Integer $count, String $prefix = "", String $fc = "first", String $lc = "last" )String
Used to output a special class for the first and last items in an indexed list, assuming a 1-based index.
-
readonly_attr( Boolean $$test )String
Returns the HTML readonly attribute if the specified $test is true.
-
select( Arguments $attr, Array $options, Array / String $vals, Array $options_attr )String
Generates the code for an HTML select. Important: the $options parameter is passed into the WOOF_HTML::options method, so please refer to that method for the supported formats.
-
selected_attr( Boolean $test )String
Generates the selected=”selected” attribute for an HTML select, based on a boolean test passed to the method.
-
strip_whitespace( $html )String
Removed the whitespace between tags from an HTML string. .
-
tag( String $tag, Arguments $attr, String $text = null, Boolean $empty_attr = false )String
Generates an enitre HTML tag with opening tag, text, and closing tag for a given tag name.