Installation

Installation

WordPress starter template

We highly recommends to use this plugin with WordPress Starter project template and WordPress Starter theme generator, based on Theme Boilerplate.

• Installing WordPress Starter
• Generating a theme

Single plugin installation

To install a plugin you just need to put the plugin files into the wp-content/plugins/wordpress-theme-framework directory. After installation you need to activate it on Dashboard > Plugins page.

Installation as Must-use plugin

If you do not plan to use another theme except the one you build with our Theme Framework, then you may add it as must-use plugin. In this way it won't appear on the Plugins page and user can't deactivate it.

To do this put the plugin files into the wp-content/mu-plugins/wordpress-theme-framework directory. By default WordPress loads only files inside wp-content/mu-plugins and doesn't load any folder-based plugin. To make it works you need to create a single file, which loads the plugin core like this:

wp-content/mu-plugins/wordpress-theme-framework.php

<?php
    require WPMU_PLUGIN_DIR . '/wordpress-theme-framework/wordpress-theme-framework.php';

First steps

After installation you can use plugin components inside your theme or plugins. However, to better understand how all components are used together, please check our Theme Boileplate.

Current WiKi documentation only describes framework Components, their purpose and features.

---

Next: Creating a Theme