├── LICENSE
├── README.md
├── notifier.xml
└── update-notifier.php


/LICENSE:
--------------------------------------------------------------------------------
 1 | Copyright (c) 2011 João Araújo (http://themeforest.net/user/unisphere)
 2 | 
 3 | Permission is hereby granted, free of charge, to any person obtaining a copy
 4 | of this software and associated documentation files (the "Software"), to deal
 5 | in the Software without restriction, including without limitation the rights
 6 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 7 | copies of the Software, and to permit persons to whom the Software is furnished
 8 | to do so, subject to the following conditions:
 9 | 
10 | The above copyright notice and this permission notice shall be included in all
11 | copies or substantial portions of the Software.
12 | 
13 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
19 | THE SOFTWARE.


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # WordPress Theme Update Notifier
 2 | 
 3 | This is a simple WordPress theme update notifier that will provide your theme Buyers with a notification every time you issue a theme update.
 4 | 
 5 | It's a very simple script that requires and assumes you have an XML file in your own server. This XML file serves as an endpoint for the script to check what the latest version of the theme is, and compares it with the current version of the theme installed in the Client's server.
 6 | 
 7 | One of the script **requirements** is that the version number are **floats**. Versions like 1.0, 1.1, 2.3 are acceptable and required.
 8 | 
 9 | ## Installation
10 | 
11 | Upload the **notifier.xml** file to your own server (the update notifier on the Client sites will check this file for the latest version)
12 | 
13 | Copy the **update-notifier.php** file to the root of the theme.
14 | 
15 | Edit your theme's **functions.php** file and include the **update-notifier.php** file with the following code:
16 | 
17 | 	require('update-notifier.php');
18 | 	
19 | Edit the **update-notifier.php** file and make the appropriate changes to the following constants:
20 | 
21 | 	define( 'NOTIFIER_THEME_NAME', 'JohnDoe' ); // The theme name
22 | 	define( 'NOTIFIER_THEME_FOLDER_NAME', 'johndoe' ); // The theme folder name
23 | 	define( 'NOTIFIER_XML_FILE', 'http://www.yourdomain.com/johndoe/notifier.xml' ); // The remote notifier XML file containing the latest version of the theme and changelog
24 | 	define( 'NOTIFIER_CACHE_INTERVAL', 21600 ); // The time interval for the remote XML cache in the database (21600 seconds = 6 hours)
25 | 	
26 | Everything should be in place now. Every time you submit a theme update you should edit the XML file in your server and change the following code to the latest version you've updated:
27 | 
28 | 	<latest>1.0</latest>
29 | 	
30 | This way, your Clients will see an update notification on the WordPress admin panel informing them that there's a new version available and they should update.
31 | 
32 | **NOTE:** when you submit theme updates make sure to update the theme version number in the **style.css** file. This file is in the root of your theme and the "Version" is the value used for comparison.
33 | 
34 | ## Screenshot
35 | 
36 | ![theme update notifier](http://content.screencast.com/users/unispheredesign/folders/Jing/media/589c4a03-9155-4af9-8769-608245f12ba4/00000107.png)
37 | 


--------------------------------------------------------------------------------
/notifier.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <notifier>
 3 | 	<latest>1.0</latest>
 4 | 	<changelog>
 5 | <![CDATA[
 6 | <h4>Version 1.0</h4>
 7 | <ul>
 8 | <li>Initial theme version.</li>
 9 | </ul>
10 | ]]>
11 | 	</changelog>
12 | </notifier>


--------------------------------------------------------------------------------
/update-notifier.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**************************************************************
  3 |  *                                                            *
  4 |  *   Provides a notification to the user everytime            *
  5 |  *   your WordPress theme is updated                          *
  6 |  *                                                            *
  7 |  *   Author: Joao Araujo                                      *
  8 |  *   Profile: http://themeforest.net/user/unisphere           *
  9 |  *   Follow me: http://twitter.com/unispheredesign            *
 10 |  *                                                            *
 11 |  **************************************************************/
 12 |  
 13 |  
 14 | 
 15 | // Constants for the theme name, folder and remote XML url
 16 | define( 'NOTIFIER_THEME_NAME', 'JohnDoe' ); // The theme name
 17 | define( 'NOTIFIER_THEME_FOLDER_NAME', 'johndoe' ); // The theme folder name
 18 | define( 'NOTIFIER_XML_FILE', 'http://www.yourdomain.com/johndoe/notifier.xml' ); // The remote notifier XML file containing the latest version of the theme and changelog
 19 | define( 'NOTIFIER_CACHE_INTERVAL', 21600 ); // The time interval for the remote XML cache in the database (21600 seconds = 6 hours)
 20 | 
 21 | 
 22 | 
 23 | // Adds an update notification to the WordPress Dashboard menu
 24 | function update_notifier_menu() {  
 25 | 	if (function_exists('simplexml_load_string')) { // Stop if simplexml_load_string funtion isn't available
 26 | 	    $xml = get_latest_theme_version(NOTIFIER_CACHE_INTERVAL); // Get the latest remote XML file on our server
 27 | 		$theme_data = get_theme_data(TEMPLATEPATH . '/style.css'); // Read theme current version from the style.css
 28 | 		
 29 | 		if( (float)$xml->latest > (float)$theme_data['Version']) { // Compare current theme version with the remote XML version
 30 | 			add_dashboard_page( NOTIFIER_THEME_NAME . ' Theme Updates', NOTIFIER_THEME_NAME . ' <span class="update-plugins count-1"><span class="update-count">New Updates</span></span>', 'administrator', 'theme-update-notifier', 'update_notifier');
 31 | 		}
 32 | 	}	
 33 | }
 34 | add_action('admin_menu', 'update_notifier_menu');  
 35 | 
 36 | 
 37 | 
 38 | // Adds an update notification to the WordPress 3.1+ Admin Bar
 39 | function update_notifier_bar_menu() {
 40 | 	if (function_exists('simplexml_load_string')) { // Stop if simplexml_load_string funtion isn't available
 41 | 		global $wp_admin_bar, $wpdb;
 42 | 	
 43 | 		if ( !is_super_admin() || !is_admin_bar_showing() ) // Don't display notification in admin bar if it's disabled or the current user isn't an administrator
 44 | 		return;
 45 | 		
 46 | 		$xml = get_latest_theme_version(NOTIFIER_CACHE_INTERVAL); // Get the latest remote XML file on our server
 47 | 		$theme_data = get_theme_data(TEMPLATEPATH . '/style.css'); // Read theme current version from the style.css
 48 | 	
 49 | 		if( (float)$xml->latest > (float)$theme_data['Version']) { // Compare current theme version with the remote XML version
 50 | 			$wp_admin_bar->add_menu( array( 'id' => 'update_notifier', 'title' => '<span>' . NOTIFIER_THEME_NAME . ' <span id="ab-updates">New Updates</span></span>', 'href' => get_admin_url() . 'index.php?page=theme-update-notifier' ) );
 51 | 		}
 52 | 	}
 53 | }
 54 | add_action( 'admin_bar_menu', 'update_notifier_bar_menu', 1000 );
 55 | 
 56 | 
 57 | 
 58 | // The notifier page
 59 | function update_notifier() { 
 60 | 	$xml = get_latest_theme_version(NOTIFIER_CACHE_INTERVAL); // Get the latest remote XML file on our server
 61 | 	$theme_data = get_theme_data(TEMPLATEPATH . '/style.css'); // Read theme current version from the style.css ?>
 62 | 	
 63 | 	<style>
 64 | 		.update-nag { display: none; }
 65 | 		#instructions {max-width: 670px;}
 66 | 		h3.title {margin: 30px 0 0 0; padding: 30px 0 0 0; border-top: 1px solid #ddd;}
 67 | 	</style>
 68 | 
 69 | 	<div class="wrap">
 70 | 	
 71 | 		<div id="icon-tools" class="icon32"></div>
 72 | 		<h2><?php echo NOTIFIER_THEME_NAME ?> Theme Updates</h2>
 73 | 	    <div id="message" class="updated below-h2"><p><strong>There is a new version of the <?php echo NOTIFIER_THEME_NAME; ?> theme available.</strong> You have version <?php echo $theme_data['Version']; ?> installed. Update to version <?php echo $xml->latest; ?>.</p></div>
 74 | 
 75 | 		<img style="float: left; margin: 0 20px 20px 0; border: 1px solid #ddd;" src="<?php echo get_bloginfo( 'template_url' ) . '/screenshot.png'; ?>" />
 76 | 		
 77 | 		<div id="instructions">
 78 | 		    <h3>Update Download and Instructions</h3>
 79 | 		    <p><strong>Please note:</strong> make a <strong>backup</strong> of the Theme inside your WordPress installation folder <strong>/wp-content/themes/<?php echo NOTIFIER_THEME_FOLDER_NAME; ?>/</strong></p>
 80 | 		    <p>To update the Theme, login to <a href="http://www.themeforest.net/">ThemeForest</a>, head over to your <strong>downloads</strong> section and re-download the theme like you did when you bought it.</p>
 81 | 		    <p>Extract the zip's contents, look for the extracted theme folder, and after you have all the new files upload them using FTP to the <strong>/wp-content/themes/<?php echo NOTIFIER_THEME_FOLDER_NAME; ?>/</strong> folder overwriting the old ones (this is why it's important to backup any changes you've made to the theme files).</p>
 82 | 		    <p>If you didn't make any changes to the theme files, you are free to overwrite them with the new ones without the risk of losing theme settings, pages, posts, etc, and backwards compatibility is guaranteed.</p>
 83 | 		</div>
 84 | 	    
 85 | 	    <h3 class="title">Changelog</h3>
 86 | 	    <?php echo $xml->changelog; ?>
 87 | 
 88 | 	</div>
 89 |     
 90 | <?php } 
 91 | 
 92 | 
 93 | 
 94 | // Get the remote XML file contents and return its data (Version and Changelog)
 95 | // Uses the cached version if available and inside the time interval defined
 96 | function get_latest_theme_version($interval) {
 97 | 	$notifier_file_url = NOTIFIER_XML_FILE;	
 98 | 	$db_cache_field = 'notifier-cache';
 99 | 	$db_cache_field_last_updated = 'notifier-cache-last-updated';
100 | 	$last = get_option( $db_cache_field_last_updated );
101 | 	$now = time();
102 | 	// check the cache
103 | 	if ( !$last || (( $now - $last ) > $interval) ) {
104 | 		// cache doesn't exist, or is old, so refresh it
105 | 		if( function_exists('curl_init') ) { // if cURL is available, use it...
106 | 			$ch = curl_init($notifier_file_url);
107 | 			curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
108 | 			curl_setopt($ch, CURLOPT_HEADER, 0);
109 | 			curl_setopt($ch, CURLOPT_TIMEOUT, 10);
110 | 			$cache = curl_exec($ch);
111 | 			curl_close($ch);
112 | 		} else {
113 | 			$cache = file_get_contents($notifier_file_url); // ...if not, use the common file_get_contents()
114 | 		}
115 | 		
116 | 		if ($cache) {			
117 | 			// we got good results	
118 | 			update_option( $db_cache_field, $cache );
119 | 			update_option( $db_cache_field_last_updated, time() );
120 | 		} 
121 | 		// read from the cache file
122 | 		$notifier_data = get_option( $db_cache_field );
123 | 	}
124 | 	else {
125 | 		// cache file is fresh enough, so read from it
126 | 		$notifier_data = get_option( $db_cache_field );
127 | 	}
128 | 	
129 | 	// Let's see if the $xml data was returned as we expected it to.
130 | 	// If it didn't, use the default 1.0 as the latest version so that we don't have problems when the remote server hosting the XML file is down
131 | 	if( strpos((string)$notifier_data, '<notifier>') === false ) {
132 | 		$notifier_data = '<?xml version="1.0" encoding="UTF-8"?><notifier><latest>1.0</latest><changelog></changelog></notifier>';
133 | 	}
134 | 	
135 | 	// Load the remote XML data into a variable and return it
136 | 	$xml = simplexml_load_string($notifier_data); 
137 | 	
138 | 	return $xml;
139 | }
140 | 
141 | ?>


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