BioShip Documentation

BioShip QuickStart

Even though BioShip has a lot to it, getting started with BioShip is actually easy. '; $vhtml .= 'The main thing to remember is you do not need to setup and use every single feature! '; $vhtml .= 'For the majority of projects the default settings for many of the options are great. '; $vhtml .= 'So the fastest way to get started is to leave them alone and focus on your design.

Practically speaking, this means customizing the Skin layer settings mostly, and '; $vhtml .= 'adjusting some Skeleton layer sidebar settings if you need to modify your sidebars. '; $vhtml .= 'Most of the Skeleton and all of the Muscle layer settings can be left for later.'; $vhtml .= '

BioShip has a lot of complex code under the hood to make everything super-flexible. '; $vhtml .= 'This means you can leave the more advanced stuff for if and when you actually need it, '; $vhtml .= 'confident and relaxed knowing that you really can change anything at all in the future. '; $vhtml .= 'And in the meantime, enjoy the simplicity of having everything setup and working sooner!

And if and when you are ready to delve deeper, complete documentation is available below. '; $vhtml .= 'I hope you enjoy using BioShip and welcome any feedback or improvements.'; $vhtml .= '

BioShip Installation

Basic Install

Preview Install

Theme Updates

Manual Theme Update

Optimization

BioShip Child Theming

One-Click Child Theme Install

Manual Child Theme Install

Preview Child Theme Install

Cloning Child Themes

BioShip Frameworks

Options Frameworks

WordPress Customizer

WordPress.Org Compliance

Titan Framework

Options Framework

v1.5.0+ Upgrade Notice

Framework Switching

Transferring Settings

Copying Theme Settings

Other Frameworks

Hybrid Core

Hybrid Hook

Foundation

BioShip Extensions

BioShip Theme Options

SKIN

".strtoupper($vlayer)."

".strtoupper($vlayer)."

".$voption['name']."

BioShip Theme Metabox

Layout Display Overrides

General Layout

Navigation

Sidebar Overrides

Sidebar Output Overrides

Sidebar Display Overrides

Content Overrides

Thumbnail/Featured Image

Content Display Overrides

Content Filters

PerPost Styles

BioShip Value Filters

'.$vsection['title'].'

'.$vfilters[$vfilter]['example'].'

BioShip Files and Hierarchy

BioShip File Hierarchy

1. the Child Theme subdirectories (if relevant)
2. the main Child Theme directory (ie. 'Stylesheet' directory)
3. the Parent Theme subdirectories (if relevant)
4. then main Parent Theme directory (ie. 'Template' directory)

CSS Stylesheets

Javascripts

Images

Core Theme File Hierarchy

Core Theme Files

Default Template Files

Library Hierarchy

BioShip Template Hierarchy

BioShip Sidebar Guide

Sidebar Template Override Usage

Override Array Examples

Override Filter Example

';
	$vhtml .= "add_filter('skeleton_sidebar_layout_override','my_portfolio_sidebars');".PHP_EOL;
	$vhtml .= "function my_portfolio_sidebars(\$sidebars) {".PHP_EOL;
	$vhtml .= "    if (get_post_type() == 'portfolio') {".PHP_EOL;
	$vhtml .= "        // use portfolio.php for right sidebar and subportfolio.php for external right subsidebar".PHP_EOL;
	$vhtml .= "        if (is_singular()) {\$sidebars = array('','','portfolio','subportfolio'};}".PHP_EOL;
	$vhtml .= "        // use portfolio-archive.php for left sidebar and subportfolio-archive.php for right subsidebar".PHP_EOL;
	$vhtml .= "        elseif (is_archive()) {\$sidebars = array('portfolio-archive','','','subportfolio-archive');}".PHP_EOL;
	$vhtml .= "    }".PHP_EOL;
	$vhtml .= "    // to preserve other sidebar behaviour, *always* return the first argument of the filter function".PHP_EOL;
	$vhtml .= "    return \$sidebars;".PHP_EOL;
	$vhtml .= "}".PHP_EOL."

PerPost Metabox Overrides

Template Hierarchy

Sidebar Template List

Sidebar Value Filters

Sidebar Width Filters

BioShip Grid System

';
	$vhtml .= '<div class="container"><div class="eight columns">COLUMN A</div>
';
	$vhtml .= '<div class="eight columns">COLUMN B</div></div>

';
	$vhtml .= '<div class="container"><div class="eight columns"><div class="inner">COLUMN A</div></div>
';
	$vhtml .= '<div class="eight columns"><div class="inner">COLUMN B</div></div></div>

BioShip Layout Hooks

Hybrid Hook

Manually Adding Functions

add_action('{hook_name}', '{function_name}', {priority});

add_action('bioship_after_header', 'custom_after_header_function', 5);
";
	$vhtml .= "function custom_after_header_function() {echo 'Welcome!';}

add_action('bioship_after_header', 'custom_welcome_shortcode', 5);
";
	$vhtml .= "function custom_welcome_shortcode() {echo do_shortcode('[welcome_shortcode']);}

Reordering Layout Functions

add_filter('bioship_header_widgets_position', 'custom_header_widgets_position');
";
	$vhtml .= "function custom_header_widgets_position() {return 2;}

add_filter('bioship_header_widgets_position', function(){return 2;} );

Removing Layout Functions

add_filter('bioship_header_widgets_position', function(){return -1;} );

bioship_remove_action('bioship_header', 'bioship_header_widgets');

add_action('init', 'custom_layout_femovals');
";
	$vhtml .= "function custom_layout_removals() {
";
	$vhtml .= "	remove_action('bioship_header', 'bioship_header_widgets', 6);
";
	$vhtml .= "}

Replacing Layout Functions

bioship_remove_action('bioship_header', 'bioship_header_widgets');
";
	$vhtml .= "add_action('bioship_navbar', 'bioship_header_widgets', 2);

Header / Footer Extra HTML

add_filter('bioship_header_html_extra', 'custom_header_html_extras');
";
	$vhtml .= "function custom_header_html_extras() {return '<div>Div Content</div>';}

Banner Positions

BioShip Theme Values

Theme Constants

BioShip Theme Debugging

HTML Page Element Comments

<!-- #sidebar -->{Sidebar Output}<!-- /#sidebar -->

Theme Debug Modes

<!-- Debug Info Description: {INFO} -->

Theme Debug to File

Included Page Templates

Theme Debug Tracer

Heavy Debugging

var_dump(debug_backtrace());