Wireframe Classes - mixatheme/Wireframe GitHub Wiki

NOTE: THIS WIKI PAGE WAS WRITTEN WAY BACK IN 2015 FOR WIREFRAME ALPHA. WE ARE CURRENTLY IN THE PROCESS OF UPDATING THESE DOCS HOPEFULLY FOR A JUNE 2017 RELEASE. THANK YOU FOR YOUR PATIENCE.

Class Reference

Base Classes

  1. Theme
  2. Container

Dependency Classes

  1. Language
  2. Features
  3. Enqueue
  4. Widgets
  5. Navigation

Module Classes

  1. Walker
  2. Editor
  3. Customizer
  4. Debug

MIXA Logo Base Classes

:ramen: Theme class

Base class for theme objects in Wireframe. Note the final keyword is used so Theme methods are not overwritten. This file was added Wireframe since version 1.0.0.

Variables:

  1. $_language
  2. $_features
  3. $_enqueue
  4. $_navigation
  5. $_widgets
  6. $_customizer

Methods:

  1. construct() - Description goes here.
  2. language() - Description goes here.
  3. features() - Description goes here.
  4. enqueue() - Description goes here.
  5. navigation() - Description goes here.
  6. widgets() - Description goes here.
  7. customizer() - Description goes here.

The Theme object cannot be extended:

final class Theme {
  // Code...
}

Most Wireframe member variables should be private:

/**
 * @access private
 * @var    array $_features
 */
$_features = array();

💡 TIP: Use an underscore for private variables and methods.

construct()
public function __construct( Language $language = null, Features $features = null, Enqueue $enqueue = null, Navigation $navigation = null, Widgets $widgets = null, Editor $editor = null, Customizer $customizer = null ) {

	$this->_language   = $language;
	$this->_features   = $features;
	$this->_enqueue    = $enqueue;
	$this->_navigation = $navigation;
	$this->_widgets    = $widgets;
	$this->_editor     = $editor;
	$this->_customizer = $customizer;
}
language()
public function language() {
	return $this->_language;
}
features()
public function features() {
	return $this->_features;
}
enqueue()
public function enqueue() {
	return $this->_enqueue;
}
navigation()
public function navigation() {
	return $this->_navigation;
}
widgets()
public function widgets() {
	return $this->_widgets;
}
customizer()
public function customizer() {
	return $this->_customizer;
}

Dependencies

  1. Class
  2. Filename

Source:

Top

:ramen: Container class

This file was added Wireframe since version 1.0.0.

Variables:

  1. $_var1
  2. $_var2

Methods:

  1. method_one() - Description goes here.
  2. method_two() - Description goes here.
method_one()
Code...
method_two()
Code...

Dependencies

  1. Class
  2. Filename

Source:

Top

MIXA Logo Dependency Classes

:ramen: Enqueue class

Dependency class for styles & scripts. This file was added Wireframe since version 1.0.0.

Variables:

  1. $_css_path
  2. $_js_path
  3. $_prefix
  4. $_css
  5. $_js

Methods:

  1. construct() - Description goes here.
  2. css() - Description goes here.
  3. js() - Description goes here.
  4. comment_reply() - Description goes here.
construct()
public function __construct( $config ) {
	$this->_stylecss = $config['stylecss'];
	$this->_comments = $config['comments'];
	$this->_media    = $config['media'];
	$this->_css_path = $config['css_path'];
	$this->_js_path  = $config['js_path'];
	$this->_prefix   = $config['prefix'];
	$this->_styles   = $config['styles'];
	$this->_scripts  = $config['scripts'];
	$this->_localize = $config['localize'];
}
css()
// Code...
js()
// Code...
comment_reply()
public function comment_reply() {
	if ( is_singular() && comments_open() && get_option( 'thread_comments' ) ) {
		wp_enqueue_script( 'comment-reply' );
	}
}

Dependencies

  1. functions.php - Uses constants.
  2. mixa_version() - Conditional versioning checks if WP_DEBUG is true, else use param.

Source:

Top

:ramen: Features class

This class sets up Wireframe's theme supports. This file was added Wireframe since version 1.0.0.

Variables:

  1. $_post_formats
  2. $_post_thumbnails
  3. $_post_thumbnails_width
  4. $_post_thumbnails_height
  5. $_custom_header
  6. $_custom_background
  7. $_custom_logo
  8. $_automatic_feed_links
  9. $_html5
  10. $_title_tag
  11. $_editor_style
  12. $_nav_menus
  13. $_content_width
  14. $_selective_refresh

Methods:

  1. construct() - Description goes here.
  2. post_formats() - Description goes here.
construct()
public function __construct( $config ) {
	$this->_custom_header        = $config['custom_header'];
	$this->_content_width        = $config['content_width'];
	$this->_post_thumbnails      = $config['post_thumbnails'];
	$this->_post_thumbnails_size = $config['post_thumbnails_size'];
	$this->_feed_links           = $config['feed_links'];
	$this->_nav_menus            = $config['nav_menus'];
	$this->_post_formats         = $config['post_formats'];
	$this->_custom_background    = $config['custom_background'];
	$this->_html5                = $config['html5'];
	$this->_title_tag            = $config['title_tag'];
	$this->_custom_logo          = $config['custom_logo'];
	$this->_selective_refresh    = $config['selective_refresh'];
}
post_formats()
public function post_formats() {
	wireframe_boolean_theme_support( 'post-formats', $this->_post_formats );
}

Dependencies

  1. Class
  2. Filename

Source:

Widgets class

This class registers Wireframe's default widgets. This file was added Wireframe since version 1.0.0.

Variables:

  1. $_var1
  2. $_var2

Methods:

  1. method_one() - Description goes here.
  2. method_two() - Description goes here.
method_one()
Code...
method_two()
Code...

Dependencies

  1. Class
  2. Filename

Source:

Top

MIXA Logo Module Classes

:ramen: Walker class

This class registers Wireframe's custom Walker for Nav Menus. This file was added Wireframe since version 1.0.0.

Variables:

  1. $_var1
  2. $_var2

Methods:

  1. method_one() - Description goes here.
  2. method_two() - Description goes here.
method_one()
Code...
method_two()
Code...

Dependencies

  1. Class
  2. Filename

Source:

Top