├── custom
    ├── custom.js
    ├── functions.php
    └── style.css
├── readme.txt
└── theme-customisations.php


/custom/custom.js:
--------------------------------------------------------------------------------
1 | jQuery(document).ready(function($){
2 | 	// Custom jQuery goes here
3 | });
4 | 


--------------------------------------------------------------------------------
/custom/functions.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Functions.php
 4 |  *
 5 |  * @package  Theme_Customisations
 6 |  * @author   WooThemes
 7 |  * @since    1.0.0
 8 |  */
 9 | 
10 | if ( ! defined( 'ABSPATH' ) ) {
11 | 	exit; // Exit if accessed directly.
12 | }
13 | 
14 | /**
15 |  * functions.php
16 |  * Add PHP snippets here
17 |  */
18 | 


--------------------------------------------------------------------------------
/custom/style.css:
--------------------------------------------------------------------------------
1 | /**
2 |  * Add any custom CSS here.
3 |  *
4 |  * This file will be loaded after all other theme stylesheets.
5 |  */


--------------------------------------------------------------------------------
/readme.txt:
--------------------------------------------------------------------------------
 1 | === Theme Customisations ===
 2 | Contributors: jameskoster, woothemes
 3 | Tags: theme, edit, edits, customise, customisation, customize, customization, css, php, jquery
 4 | Requires at least: 3.0.0
 5 | Tested up to: 4.5.2
 6 | Stable tag: 1.0.0
 7 | License: GPLv2 or later
 8 | License URI: http://www.gnu.org/licenses/gpl-2.0.html
 9 | 
10 | A handy little plugin to contain your theme/plugin customisation snippets.
11 | 
12 | == Description ==
13 | 
14 | Think of this plugin as an alternative to adding code snippets to the functions.php, or style.css file in your child theme. Why? It keeps all of your changes in one location, independent of the other components that make up your web site. That means you can safely perform theme / plugin updates without the worry of losing your modifications as well as easily deactivating your customisations to check for conflicts.
15 | 
16 | *Note:* This plugin doesn't actually do anything on its own. It is purely a convenient place for you to store your own theme/plugin customisations.
17 | 
18 | == Installation ==
19 | 
20 | 1. Upload `theme-customisations` to the `/wp-content/plugins/` directory
21 | 2. Add your customisations to the plugin either locally or via Plugins > Editor in the Dashboard
22 | 3. Activate the plugin through the 'Plugins' menu in WordPress
23 | 4. Done!
24 | 
25 | == Usage ==
26 | 
27 | * Add any CSS snippets to `custom/style.css`. This file is found in this plugin.
28 | * Add any PHP snippets to `custom/functions.php`. This file is found in this plugin.
29 | * Add any jQuery snippets to `custom/custom.js`. This file is found in this plugin.
30 | * Add custom top level template files (page.php, single.php etc) to `custom/templates/`. You will need to create the templates folder.
31 | * Add any WooCommerce template files to `custom/templates/woocommerce`. You will need to create the templates and woocommerce folders.
32 | * Activate the plugin.
33 | 
34 | == Frequently Asked Questions ==
35 | 
36 | = Isn't this what child themes are for? =
37 | 
38 | Well, kind of. Sure, you can put your modifications in a child theme, but there are many places (including woothemes.com and wordpress.org) to download and use child themes. If you decide to use a child theme built by a third party and make modifications there, you would lose them when performing updates. Also if you make all your modifications in your own custom child theme then realise that you want to use a child theme from your favorite theme vendor, you'll have to move all of your modifications somewhere else. To avoid that hassle, use this plugin.
39 | 
40 | = What templates can I override via this plugin? =
41 | 
42 | As you know, to override a parent themes template file via child theme you can just copy/paste it into your child theme. This is the one drawback of using this plugin - you can only override top level templates - not template partials. This means that you could add a `page.php` template file to the `/custom/templates/` dir of this plugin and it would work fine. You could not however add a `header.php` or `footer.php` template file. Those would not work.
43 | 
44 | = Should I put all my customisations in this single plugin? =
45 | 
46 | That's entirely up to you. There's nothing to stop you from duplicating this plugin and changing the name. That way you could theoretically keep each of your customisations in their own individual plugins. This can be very handy when debugging, or if you want to quickly enable/disable a specific customisations temporarily.
47 | 


--------------------------------------------------------------------------------
/theme-customisations.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Plugin Name:       Theme Customisations
  4 |  * Description:       A handy little plugin to contain your theme customisation snippets.
  5 |  * Plugin URI:        http://github.com/woothemes/theme-customisations
  6 |  * Version:           1.0.0
  7 |  * Author:            WooThemes
  8 |  * Author URI:        https://www.woocommerce.com/
  9 |  * Requires at least: 3.0.0
 10 |  * Tested up to:      4.4.2
 11 |  *
 12 |  * @package Theme_Customisations
 13 |  */
 14 | 
 15 | if ( ! defined( 'ABSPATH' ) ) {
 16 | 	exit; // Exit if accessed directly.
 17 | }
 18 | 
 19 | /**
 20 |  * Main Theme_Customisations Class
 21 |  *
 22 |  * @class Theme_Customisations
 23 |  * @version	1.0.0
 24 |  * @since 1.0.0
 25 |  * @package	Theme_Customisations
 26 |  */
 27 | final class Theme_Customisations {
 28 | 
 29 | 	/**
 30 | 	 * Set up the plugin
 31 | 	 */
 32 | 	public function __construct() {
 33 | 		add_action( 'init', array( $this, 'theme_customisations_setup' ), -1 );
 34 | 		require_once( 'custom/functions.php' );
 35 | 	}
 36 | 
 37 | 	/**
 38 | 	 * Setup all the things
 39 | 	 */
 40 | 	public function theme_customisations_setup() {
 41 | 		add_action( 'wp_enqueue_scripts', array( $this, 'theme_customisations_css' ), 999 );
 42 | 		add_action( 'wp_enqueue_scripts', array( $this, 'theme_customisations_js' ) );
 43 | 		add_filter( 'template_include',   array( $this, 'theme_customisations_template' ), 11 );
 44 | 		add_filter( 'wc_get_template',    array( $this, 'theme_customisations_wc_get_template' ), 11, 5 );
 45 | 	}
 46 | 
 47 | 	/**
 48 | 	 * Enqueue the CSS
 49 | 	 *
 50 | 	 * @return void
 51 | 	 */
 52 | 	public function theme_customisations_css() {
 53 | 		wp_enqueue_style( 'custom-css', plugins_url( '/custom/style.css', __FILE__ ) );
 54 | 	}
 55 | 
 56 | 	/**
 57 | 	 * Enqueue the Javascript
 58 | 	 *
 59 | 	 * @return void
 60 | 	 */
 61 | 	public function theme_customisations_js() {
 62 | 		wp_enqueue_script( 'custom-js', plugins_url( '/custom/custom.js', __FILE__ ), array( 'jquery' ) );
 63 | 	}
 64 | 
 65 | 	/**
 66 | 	 * Look in this plugin for template files first.
 67 | 	 * This works for the top level templates (IE single.php, page.php etc). However, it doesn't work for
 68 | 	 * template parts yet (content.php, header.php etc).
 69 | 	 *
 70 | 	 * Relevant trac ticket; https://core.trac.wordpress.org/ticket/13239
 71 | 	 *
 72 | 	 * @param  string $template template string.
 73 | 	 * @return string $template new template string.
 74 | 	 */
 75 | 	public function theme_customisations_template( $template ) {
 76 | 		if ( file_exists( untrailingslashit( plugin_dir_path( __FILE__ ) ) . '/custom/templates/' . basename( $template ) ) ) {
 77 | 			$template = untrailingslashit( plugin_dir_path( __FILE__ ) ) . '/custom/templates/' . basename( $template );
 78 | 		}
 79 | 
 80 | 		return $template;
 81 | 	}
 82 | 
 83 | 	/**
 84 | 	 * Look in this plugin for WooCommerce template overrides.
 85 | 	 *
 86 | 	 * For example, if you want to override woocommerce/templates/cart/cart.php, you
 87 | 	 * can place the modified template in <plugindir>/custom/templates/woocommerce/cart/cart.php
 88 | 	 *
 89 | 	 * @param string $located is the currently located template, if any was found so far.
 90 | 	 * @param string $template_name is the name of the template (ex: cart/cart.php).
 91 | 	 * @return string $located is the newly located template if one was found, otherwise
 92 | 	 *                         it is the previously found template.
 93 | 	 */
 94 | 	public function theme_customisations_wc_get_template( $located, $template_name, $args, $template_path, $default_path ) {
 95 | 		$plugin_template_path = untrailingslashit( plugin_dir_path( __FILE__ ) ) . '/custom/templates/woocommerce/' . $template_name;
 96 | 
 97 | 		if ( file_exists( $plugin_template_path ) ) {
 98 | 			$located = $plugin_template_path;
 99 | 		}
100 | 
101 | 		return $located;
102 | 	}
103 | } // End Class
104 | 
105 | /**
106 |  * The 'main' function
107 |  *
108 |  * @return void
109 |  */
110 | function theme_customisations_main() {
111 | 	new Theme_Customisations();
112 | }
113 | 
114 | /**
115 |  * Initialise the plugin
116 |  */
117 | add_action( 'plugins_loaded', 'theme_customisations_main' );
118 | 


--------------------------------------------------------------------------------