Created
January 3, 2012 16:10
-
-
Save simonwheatley/1555550 to your computer and use it in GitHub Desktop.
GSA for WordPress Multisite
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
<?php | |
/** | |
* Handles most of the work. | |
* | |
* @package GSA for WordPress Multisite | |
* @author Simon Wheatley | |
**/ | |
class GSAForWPMS extends GSAForWPMS_Plugin { | |
/** | |
* The search results HTML provided by the GSA, | |
* or false if none have been provided yet. | |
* | |
* @var string|bool | |
**/ | |
protected $search_results; | |
/** | |
* The settings used for this query. | |
* | |
* @var array|bool | |
**/ | |
protected $settings; | |
/** | |
* The URL we hit on the GSA to get the search | |
* results being displayed. | |
* | |
* @var string | |
**/ | |
protected $request_url; | |
/** | |
* The request vars passed to the GSA to retrieve | |
* the search results being displayed. | |
* | |
* @var array | |
**/ | |
protected $request_vars; | |
/** | |
* The full HTTP reply object from the WordPress | |
* HTTP API. | |
* | |
* @var object | |
**/ | |
protected $reply; | |
/** | |
* A flag which determines whether to show some | |
* debugging information. | |
* | |
* @var boolean | |
**/ | |
protected $debug; | |
/** | |
* A flag which determines whether we have already | |
* shown some debugging information. | |
* | |
* @var boolean | |
**/ | |
protected $shown_debug; | |
/** | |
* Initiate! | |
* | |
* @return void | |
* @author Simon Wheatley | |
**/ | |
public function __construct() { | |
$this->setup( 'wpms_gsa', 'plugin' ); | |
$this->add_action( 'admin_init' ); | |
$this->add_action( 'admin_menu' ); | |
$this->add_action( 'gsa_search_box', 'search_box' ); | |
$this->add_action( 'init' ); | |
$this->add_action( 'load-settings_page_gsa_network_settings', 'load_network_settings' ); | |
$this->add_action( 'network_admin_menu' ); | |
$this->add_action( 'wp_ajax_gsa_ss', 'ajax_suggestion_proxy' ); | |
$this->add_action( 'wp_ajax_nopriv_gsa_ss', 'ajax_suggestion_proxy' ); | |
$this->add_filter( 'the_content' ); | |
$this->debug = true; | |
$this->shown_debug = false; | |
$this->get_search_results = false; | |
$this->search_results = false; | |
} | |
// HOOKS AND ALL THAT | |
// ================== | |
/** | |
* Hooks the WordPress admin_init action to | |
* register the setting for | |
* | |
* @return void | |
**/ | |
public function admin_init() { | |
if ( ! is_network_admin() ) | |
register_setting( 'wpms_gsa', 'wpms_gsa' ); | |
} | |
/** | |
* Hooks the WP AJAX action fired by the suggestion JS and | |
* provides a proxy to the GSA on another domain to bypass | |
* JS cross-domain issues. | |
* | |
* @return void | |
**/ | |
public function ajax_suggestion_proxy() { | |
$suggest_api_url = esc_url( trailingslashit( $this->get_network_option( 'gsa_location' ) ) . 'suggest' ); | |
$get_url = add_query_arg( $_GET, $suggest_api_url ); | |
$get_url = remove_query_arg( 'action', $get_url ); | |
$reply = wp_remote_get( $get_url ); | |
echo $reply[ 'body' ]; | |
exit; | |
} | |
/** | |
* Hooks the WP init action to queue some Javascript and | |
* set some initial Javascript values. | |
* | |
* @return void | |
**/ | |
public function init() { | |
$this->enqueue_frontend_resources(); | |
$this->maybe_get_search_results(); | |
} | |
/** | |
* Hooks the load action for the network settings page. | |
* | |
* @return void | |
**/ | |
public function load_network_settings() { | |
$do_something = $_POST[ 'wpms_gsa_form' ]; | |
if ( ! $do_something ) | |
return; | |
check_admin_referer( 'wpms_gsa_network_settings' ); | |
$options = $_POST[ 'wpms_gsa' ]; | |
update_site_option( 'wpms_gsa', $options ); | |
// Clear the object cache, shouldn't have to, but we do. | |
wp_cache_flush(); | |
} | |
/** | |
* Hooks the WP admin_menu option to add | |
* a page for the local site settings. | |
* | |
* @return void | |
**/ | |
public function admin_menu() { | |
add_options_page( sprintf( __( 'GSA Settings for the %s site', 'wpms_gsa' ), get_bloginfo( 'name' ) ), __( 'GSA Local Settings', 'wpms_gsa' ), 'manage_options', 'gsa_site_settigns', array( $this, 'site_options' ) ); | |
} | |
/** | |
* Hooks the WP network_admin_menu option to | |
* to add a page for the network settings. | |
* | |
* @return void | |
**/ | |
public function network_admin_menu() { | |
add_submenu_page( 'settings.php', __( 'GSA Network Settings' ), __( 'GSA Network Settings' ), 'manage_options', 'gsa_network_settings', array( $this, 'network_options' ) ); | |
} | |
/** | |
* Display the search form controls. | |
* | |
* @return void | |
**/ | |
public function search_box() { | |
$vars = array(); | |
if ( $this->get_network_option( 'use_gsa' ) ) { | |
$this->render( 'search-box.php' ); | |
} else { | |
$this->render( 'original-search-box.php' ); | |
} | |
} | |
/** | |
* Hooks the WP filter the_content to replace the | |
* main content of the page with the search results | |
* if we have them. | |
* | |
* @param string $content The content from WordPress | |
* @return string The content | |
**/ | |
public function the_content( $content ) { | |
if ( $this->get_search_results && $this->debug && ! $this->shown_debug ) { | |
$debug = '<div style="display: block; background-color: #ffc; padding: 10px; width: 400px; overflow: scroll;"><p><strong style="color:#c00;">GSA Response Debug Info</strong></p>'; | |
$debug .= "<pre>Settings: " . print_r( $this->settings, true ) . "\n</pre>"; | |
$debug .= "<pre>Request URL: $this->request_url\n</pre>"; | |
$debug .= "<pre>Request GET params: " . print_r( $this->request_vars, true ) . "\n</pre>"; | |
$debug .= "<pre>Full HTTP reply: " . htmlspecialchars( print_r( $this->reply, true ) ) . "\n</pre>"; | |
$debug .= '</div>'; | |
echo $debug; | |
$this->shown_debug = true; | |
} | |
if ( $this->search_results ) | |
$content = $this->search_results; | |
return $content; | |
} | |
// CALLBACKS | |
// ========= | |
/** | |
* A callback providing HTML for the site options page, | |
* (as opposed to the network options page). | |
* | |
* @return void | |
**/ | |
public function site_options() { | |
echo "<p>Site options</p>"; | |
} | |
/** | |
* A callback providing HTML for the network options page, | |
* (as opposed to the individual site options page). | |
* | |
* @return void | |
**/ | |
public function network_options() { | |
$vars = array(); | |
$this->render_admin( 'network-options.php' ); | |
} | |
// UTILITIES | |
// ========= | |
/** | |
* Enqueues any frontend JS or CSS we need. | |
* | |
* @return void | |
**/ | |
protected function enqueue_frontend_resources() { | |
if ( is_admin() ) | |
return; | |
wp_enqueue_script( 'gsa-xmlhttp', $this->url( '/js/xmlhttp.js' ), array(), '1', false ); | |
wp_enqueue_script( 'gsa-ss', $this->url( '/js/ss.js' ), array(), '1', false ); | |
$data = array( | |
'form_element' => 'ssform', // Search form name | |
'popup_element' => 'search_suggest', // Table | |
'site' => $this->get_network_option( 'site', '' ), // Suggestions origin | |
'client' => $this->get_network_option( 'client', '' ), // Suggestions origin | |
'gsa_host' => admin_url( 'admin-ajax.php' ), // AJAX proxy | |
); | |
wp_localize_script( 'gsa-ss', 'gsa_ss', $data ); | |
} | |
/** | |
* Fetches search results from the remote GSA, if they are required, | |
* and stores them in a property on this class. | |
* | |
* @TODO: Ultimately we will cache these for a short period to reduce server load. | |
* | |
* @return void | |
**/ | |
protected function maybe_get_search_results() { | |
if ( is_admin() ) | |
return; | |
if ( is_front_page() ) | |
return; // We only display search results on front pages | |
$q = isset( $_GET[ 's' ] ) ? $_GET[ 's' ] : false; | |
$subsite = isset( $_GET[ 'gsa' ] ) ? $_GET[ 'gsa' ] : false; | |
if ( ! $q || ! $subsite ) | |
return; // Nothing to do | |
$this->get_search_results = true; | |
$this->request_url = $this->get_network_option( 'gsa_location' ); | |
$this->request_url = add_query_arg( $_GET, $this->request_url ); | |
$this->request_url .= $this->get_network_option( 'gsa_fixed_params' ); // @TODO: Make this more user friendly | |
// Check the subsite options, use default if it does not exist | |
$subsite = 'default'; | |
$this->settings = $this->get_network_option( 'gsa_subsite_' . $subsite ); | |
$args = array( | |
'q' => $_GET[ 's' ], // The actual query is translated from 's' => 'q' | |
'client' => $this->settings[ 'client' ], | |
'site' => $this->settings[ 'site' ], | |
'proxystylesheet' => $this->settings[ 'proxystylesheet' ], | |
); | |
$this->request_url = add_query_arg( $args, $this->request_url ); | |
// Get the contents | |
$this->reply = wp_remote_get( $this->request_url ); | |
// Now for debugging purposes | |
$request = parse_url( $this->request_url ); | |
parse_str( $request[ 'query' ], $this->request_vars ); | |
if ( is_wp_error( $this->reply ) ) { | |
$this->search_results = '<p>' . __( 'Unfortunately our site search is unavailable, please try again shortly.', 'wpms_gsa' ) . '</p>'; | |
} | |
// What other codes could the GSA return? | |
if ( 200 != $this->reply[ 'response' ][ 'code' ] ) { | |
// @TODO: Probably need more debugging gear in here if the GSA is not returning 200s? | |
$this->search_results = false; | |
} else { | |
$this->search_results = $this->reply[ 'body' ]; | |
} | |
} | |
/** | |
* Returns the named option from the network options. | |
* | |
* @param string $name The name of an option within this plugin's network options | |
* @param mixed $default_value The value to fall back on if there's nothing stored | |
* @return mixed The value of the option | |
**/ | |
protected function get_network_option( $name, $default_value = false ) { | |
$options = (array) get_site_option( 'wpms_gsa' ); | |
if ( ! isset( $options[ $name ] ) ) | |
return $default_value; | |
return $options[ $name ]; | |
} | |
} // END GSAForWPMS class | |
$gsa_for_wp_ms = new GSAForWPMS(); | |
?> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
<?php | |
// ====================================================================================== | |
// This library is free software; you can redistribute it and/or | |
// modify it under the terms of the GNU Lesser General Public | |
// License as published by the Free Software Foundation; either | |
// version 2.1 of the License, or (at your option) any later version. | |
// | |
// This library is distributed in the hope that it will be useful, | |
// but WITHOUT ANY WARRANTY; without even the implied warranty of | |
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
// Lesser General Public License for more details. | |
// ====================================================================================== | |
// @author Simon Wheatley (http://simonwheatley.co.uk) | |
// @version 1.0 | |
// @copyright Copyright © 2010 Simon Wheatley, All Rights Reserved | |
// @copyright Some parts Copyright © 2007 John Godley, All Rights Reserved | |
// ====================================================================================== | |
// 1.0 - Initial release | |
// 1.01 - Added add_shortcode | |
// 1.10 - Added code to allow the base class to be used in a theme | |
// 1.2 - Truncate helper method, admin notices/errors, throw error if not provided | |
// with name in setup method call, default $pluginfile to __FILE__, bugfix around | |
// option key in delete_option method. | |
// 1.3 - Locale stuff | |
// - Fix for get_option | |
// 1.31 - Attempt to cope with Win32 directory separators | |
// 1.32 - Add a remove_filter method | |
// 1.33 - Add `sil_plugins_dir` and `sil_plugins_url` filters, to allow placement | |
// outside the `wp-content/plugins/` folder, for example using `require_once` | |
// to include from the theme `functions.php`. | |
// ====================================================================================== | |
/** | |
* Wraps up several useful functions for WordPress plugins and provides a method to separate | |
* display HTML from PHP code. | |
* | |
* <h4>Display Rendering</h4> | |
* | |
* The class uses a similar technique to Ruby On Rails views, whereby the display HTML is kept | |
* in a separate directory and file from the main code. A display is 'rendered' (sent to the browser) | |
* or 'captured' (returned to the calling function). | |
* | |
* Template files are separated into two areas: admin and user. Admin templates are only for display in | |
* the WordPress admin interface, while user templates are typically for display on the site (although neither | |
* of these are enforced). All templates are PHP code, but are referred to without .php extension. | |
* | |
* The reason for this separation is that one golden rule of plugin creation is that someone will | |
* always want to change the formatting and style of your output. Rather than forcing them to | |
* modify the plugin (bad), or modify files within the plugin (equally bad), the class allows | |
* user templates to be overridden with files contained within the theme. | |
* | |
* An additional benefit is that it leads to code re-use, especially with regards to Ajax (i.e. | |
* your display code can be called from many locations) | |
* | |
* @package GSA for WordPress Multisite | |
* @author Simon Wheatley | |
* @copyright Copyright (C) Simon Wheatley (except where noted) | |
**/ | |
class GSAForWPMS_Plugin { | |
/** | |
* The name of this plugin | |
* | |
* @var string | |
**/ | |
protected $name; | |
/** | |
* The filepath to the directory containing this plugin | |
* | |
* @var string | |
**/ | |
protected $dir; | |
/** | |
* The URL for the directory containing this plugin | |
* | |
* @var string | |
**/ | |
protected $url; | |
/** | |
* The name of the directory containing this plugin, e.g. "my-plugin" | |
* | |
* @var string | |
**/ | |
protected $folder; | |
/** | |
* Useful for switching between debug and compressed scripts. | |
* | |
* @var string | |
**/ | |
protected $suffix; | |
/** | |
* Records the type of this class, either 'plugin' or 'theme'. | |
* | |
* @var string | |
**/ | |
protected $type; | |
/** | |
* Note the name of the function to call when the theme is activated. | |
* | |
* @var string | |
**/ | |
protected $theme_activation_function; | |
/** | |
* Initiate! | |
* | |
* @return void | |
* @author Simon Wheatley | |
**/ | |
public function setup( $name = '', $type = null ) { | |
if ( ! $name ) | |
throw new exception( "Please pass the name parameter into the setup method." ); | |
$this->name = $name; | |
// Attempt to handle a Windows | |
$ds = ( defined( 'DIRECTORY_SEPARATOR' ) ) ? DIRECTORY_SEPARATOR : '\\'; | |
$file = str_replace( $ds, '/', __FILE__ ); | |
$plugins_dir = str_replace( $ds, '/', WP_PLUGIN_DIR ); | |
// Setup the dir and url for this plugin/theme | |
if ( 'theme' == $type ) { | |
// This is a theme | |
$this->type = 'theme'; | |
$this->dir = get_stylesheet_directory(); | |
$this->url = get_stylesheet_directory_uri(); | |
} elseif ( stripos( $file, $plugins_dir ) !== false || 'plugin' == $type ) { | |
// This is a plugin | |
$this->folder = trim( basename( dirname( $file ) ), '/' ); | |
$this->type = 'plugin'; | |
// Allow someone to override the assumptions we're making here about where | |
// the plugin is held. For example, if this plugin is included as part of | |
// the files for a theme, in wp-content/themes/[your theme]/plugins/ then | |
// you could hook `sil_plugins_dir` and `sil_plugins_url` to correct | |
// our assumptions. | |
// N.B. Because this code is running when the file is required, other plugins | |
// may not be loaded and able to hook these filters! | |
$plugins_dir = apply_filters( 'sil_plugins_dir', $plugins_dir, $this->name ); | |
$plugins_url = apply_filters( 'sil_plugins_url', plugins_url(), $this->name ); | |
$this->dir = trailingslashit( $plugins_dir ) . $this->folder . '/'; | |
$this->url = trailingslashit( $plugins_url ) . $this->folder . '/'; | |
} else { | |
// WTF? | |
error_log( 'PLUGIN/THEME ERROR: Cannot find ' . $plugin_dir . ' or "themes" in ' . $file ); | |
} | |
// Suffix for enqueuing | |
$this->suffix = defined('SCRIPT_DEBUG') && SCRIPT_DEBUG ? '.dev' : ''; | |
if ( is_admin() ) { | |
// Admin notices | |
$this->add_action( 'admin_notices', '_admin_notices' ); | |
} | |
$this->add_action( 'init', 'load_locale' ); | |
} | |
/** | |
* Hook called to change the locale directory. | |
* | |
* @return void | |
* @author © John Godley | |
**/ | |
function load_locale() { | |
// Here we manually fudge the plugin locale as WP doesnt allow many options | |
$locale = get_locale(); | |
if( empty( $locale ) ) | |
$locale = 'en_US'; | |
$mofile = $this->dir( "/locale/$locale.mo" ); | |
load_textdomain( $this->name, $mofile ); | |
} | |
/** | |
* Register a WordPress action and map it back to the calling object | |
* | |
* @param string $action Name of the action | |
* @param string $function Function name (optional) | |
* @param int $priority WordPress priority (optional) | |
* @param int $accepted_args Number of arguments the function accepts (optional) | |
* @return void | |
* @author © John Godley | |
**/ | |
function add_action ($action, $function = '', $priority = 10, $accepted_args = 1) { | |
if ( $priority === null ) | |
$priority = 10; | |
add_action ($action, array (&$this, $function == '' ? $action : $function), $priority, $accepted_args); | |
} | |
/** | |
* Register a WordPress filter and map it back to the calling object | |
* | |
* @param string $action Name of the action | |
* @param string $function Function name (optional) | |
* @param int $priority WordPress priority (optional) | |
* @param int $accepted_args Number of arguments the function accepts (optional) | |
* @return void | |
* @author © John Godley | |
**/ | |
function add_filter ($filter, $function = '', $priority = 10, $accepted_args = 1) { | |
add_filter ($filter, array (&$this, $function == '' ? $filter : $function), $priority, $accepted_args); | |
} | |
/** | |
* De-register a WordPress filter and map it back to the calling object | |
* | |
* @param string $action Name of the action | |
* @param string $function Function name (optional) | |
* @param int $priority WordPress priority (optional) | |
* @param int $accepted_args Number of arguments the function accepts (optional) | |
* @return void | |
* @author © John Godley | |
**/ | |
function remove_filter ($filter, $function = '', $priority = 10, $accepted_args = 1) { | |
remove_filter ($filter, array (&$this, $function == '' ? $filter : $function), $priority, $accepted_args); | |
} | |
/** | |
* Special activation function that takes into account the plugin directory | |
* | |
* @param string $pluginfile The plugin file location (i.e. __FILE__) | |
* @param string $function Optional function name, or default to 'activate' | |
* @return void | |
* @author © John Godley | |
**/ | |
function register_activation ( $pluginfile = __FILE__, $function = '' ) { | |
if ( $this->type == 'plugin' ) { | |
add_action ('activate_'.basename (dirname ($pluginfile)).'/'.basename ($pluginfile), array (&$this, $function == '' ? 'activate' : $function)); | |
} elseif ( $this->type == 'theme' ) { | |
$this->theme_activation_function = ( $function ) ? $function : 'activate'; | |
add_action ('load-themes.php', array ( & $this, 'theme_activation' ) ); | |
} | |
} | |
/** | |
* Hack to catch theme activation. We hook the load-themes.php action, look for the | |
* "activated" GET param and make a big fat assumption if we find it. | |
* | |
* @return void | |
* @author Simon Wheatley | |
**/ | |
public function theme_activation() { | |
$activated = (bool) @ $_GET[ 'activated' ]; | |
if ( ! $activated ) | |
return; | |
if ( ! $this->theme_activation_function ) | |
return; | |
// Looks like the theme might just have been activated, call the registered function | |
$this->{$this->theme_activation_function}(); | |
} | |
/** | |
* Special deactivation function that takes into account the plugin directory | |
* | |
* @param string $pluginfile The plugin file location (i.e. __FILE__) | |
* @param string $function Optional function name, or default to 'deactivate' | |
* @return void | |
* @author © John Godley | |
**/ | |
function register_deactivation ($pluginfile, $function = '') { | |
add_action ('deactivate_'.basename (dirname ($pluginfile)).'/'.basename ($pluginfile), array (&$this, $function == '' ? 'deactivate' : $function)); | |
} | |
/** | |
* Renders a template, looking first for the template file in the theme directory | |
* and afterwards in this plugin's /theme/ directory. | |
* | |
* @return void | |
* @author Simon Wheatley | |
**/ | |
protected function render( $template_file, $vars = null ) { | |
// Maybe override the template with our own file | |
$template_file = $this->locate_template( $template_file ); | |
// Ensure we have the same vars as regular WP templates | |
global $posts, $post, $wp_did_header, $wp_did_template_redirect, $wp_query, $wp_rewrite, $wpdb, $wp_version, $wp, $id, $comment, $user_ID; | |
if ( is_array($wp_query->query_vars) ) | |
extract($wp_query->query_vars, EXTR_SKIP); | |
// Plus our specific template vars | |
if ( is_array( $vars ) ) | |
extract( $vars ); | |
require( $template_file ); | |
} | |
/** | |
* Renders an admin template from this plugin's /templates-admin/ directory. | |
* | |
* @return void | |
* @author Simon Wheatley | |
**/ | |
protected function render_admin( $template_file, $vars = null ) { | |
// Plus our specific template vars | |
if ( is_array( $vars ) ) | |
extract( $vars ); | |
// Try to render | |
if ( file_exists( $this->dir( "templates-admin/$template_file" ) ) ) { | |
require( $this->dir( "templates-admin/$template_file" ) ); | |
} else { | |
$msg = sprintf( __( "This plugin admin template could not be found: %s" ), $this->dir( "templates-admin/$template_file" ) ); | |
error_log( "Plugin template error: $msg" ); | |
echo "<p style='background-color: #ffa; border: 1px solid red; color: #300; padding: 10px;'>$msg</p>"; | |
} | |
} | |
/** | |
* Returns a section of user display code, returning the rendered markup. | |
* | |
* @param string $ug_name Name of the admin file (without extension) | |
* @param string $array Array of variable name=>value that is available to the display code (optional) | |
* @return void | |
* @author © John Godley | |
**/ | |
protected function capture( $template_file, $vars = null ) { | |
ob_start(); | |
$this->render( $template_file, $vars ); | |
$output = ob_get_contents(); | |
ob_end_clean(); | |
return $output; | |
} | |
/** | |
* Returns a section of user display code, returning the rendered markup. | |
* | |
* @param string $ug_name Name of the admin file (without extension) | |
* @param string $array Array of variable name=>value that is available to the display code (optional) | |
* @return void | |
* @author © John Godley | |
**/ | |
protected function capture_admin( $template_file, $vars = null ) { | |
ob_start(); | |
$this->render_admin( $template_file, $vars ); | |
$output = ob_get_contents(); | |
ob_end_clean(); | |
return $output; | |
} | |
/** | |
* Hooks the WP admin_notices action to render any notices | |
* that have been set with the set_admin_notice method. | |
* | |
* @return void | |
* @author Simon Wheatley | |
**/ | |
public function _admin_notices() { | |
$notices = $this->get_option( 'admin_notices' ); | |
$errors = $this->get_option( 'admin_errors' ); | |
if ( $errors ) | |
foreach ( $errors as $error ) | |
$this->render_admin_error( $error ); | |
$this->delete_option( 'admin_errors' ); | |
if ( $notices ) | |
foreach ( $notices as $notice ) | |
$this->render_admin_notice( $notice ); | |
$this->delete_option( 'admin_notices' ); | |
} | |
/** | |
* Echoes some HTML for an admin notice. | |
* | |
* @param string $notice The notice | |
* @return void | |
* @author Simon Wheatley | |
**/ | |
protected function render_admin_notice( $notice ) { | |
echo "<div class='updated'><p>$notice</p></div>"; | |
} | |
/** | |
* Echoes some HTML for an admin error. | |
* | |
* @param string $error The error | |
* @return void | |
* @author Simon Wheatley | |
**/ | |
protected function render_admin_error( $error ) { | |
echo "<div class='error'><p>$error</p></div>"; | |
} | |
/** | |
* Sets a string as an admin notice. | |
* | |
* @param string $msg A *localised* admin notice message | |
* @return void | |
* @author Simon Wheatley | |
**/ | |
protected function set_admin_notice( $msg ) { | |
$notices = (array) $this->get_option( 'admin_notices' ); | |
$notices[] = $msg; | |
$this->update_option( 'admin_notices', $notices ); | |
} | |
/** | |
* Sets a string as an admin error. | |
* | |
* @param string $msg A *localised* admin error message | |
* @return void | |
* @author Simon Wheatley | |
**/ | |
protected function set_admin_error( $msg ) { | |
$errors = (array) $this->get_option( 'admin_errors' ); | |
$errors[] = $msg; | |
$this->update_option( 'admin_errors', $errors ); | |
} | |
/** | |
* Takes a filename and attempts to find that in the designated plugin templates | |
* folder in the theme (defaults to main theme directory, but uses a custom filter | |
* to allow theme devs to specify a sub-folder for all plugin template files using | |
* this system). | |
* | |
* Searches in the STYLESHEETPATH before TEMPLATEPATH to cope with themes which | |
* inherit from a parent theme by just overloading one file. | |
* | |
* @param string $template_file A template filename to search for | |
* @return string The path to the template file to use | |
* @author Simon Wheatley | |
**/ | |
protected function locate_template( $template_file ) { | |
$located = ''; | |
$sub_dir = apply_filters( 'sw_plugin_tpl_dir', '' ); | |
if ( $sub_dir ) | |
$sub_dir = trailingslashit( $sub_dir ); | |
// If there's a tpl in a (child theme or theme with no child) | |
if ( file_exists( STYLESHEETPATH . "/$sub_dir" . $template_file ) ) | |
return STYLESHEETPATH . "/$sub_dir" . $template_file; | |
// If there's a tpl in the parent of the current child theme | |
else if ( file_exists( TEMPLATEPATH . "/$sub_dir" . $template_file ) ) | |
return TEMPLATEPATH . "/$sub_dir" . $template_file; | |
// Fall back on the bundled plugin template (N.B. no filtered subfolder involved) | |
else if ( file_exists( $this->dir( "templates/$template_file" ) ) ) | |
return $this->dir( "templates/$template_file" ); | |
// Oh dear. We can't find the template. | |
$msg = sprintf( __( "This plugin template could not be found, perhaps you need to hook `sil_plugins_dir` and `sil_plugins_url`: %s" ), $this->dir( "templates/$template_file" ) ); | |
error_log( "Template error: $msg" ); | |
echo "<p style='background-color: #ffa; border: 1px solid red; color: #300; padding: 10px;'>$msg</p>"; | |
} | |
/** | |
* Register a WordPress meta box | |
* | |
* @param string $id ID for the box, also used as a function name if none is given | |
* @param string $title Title for the box | |
* @param int $page The type of edit page on which to show the box (post, page, link). | |
* @param string $function Function name (optional) | |
* @param string $context e.g. 'advanced' or 'core' (optional) | |
* @param int $priority Priority, rough effect on the ordering (optional) | |
* @param mixed $args Some arguments to pass to the callback function as part of a larger object (optional) | |
* @return void | |
* @author © John Godley | |
**/ | |
function add_meta_box( $id, $title, $function = '', $page, $context = 'advanced', $priority = 'default', $args = null ) | |
{ | |
require_once( ABSPATH . 'wp-admin/includes/template.php' ); | |
add_meta_box( $id, $title, array( &$this, $function == '' ? $id : $function ), $page, $context, $priority, $args ); | |
} | |
/** | |
* Add hook for shortcode tag. | |
* | |
* There can only be one hook for each shortcode. Which means that if another | |
* plugin has a similar shortcode, it will override yours or yours will override | |
* theirs depending on which order the plugins are included and/or ran. | |
* | |
* @param string $tag Shortcode tag to be searched in post content. | |
* @param callable $func Hook to run when shortcode is found. | |
*/ | |
protected function add_shortcode( $tag, $function = null ) { | |
add_shortcode( $tag, array( &$this, $function == '' ? $tag : $function ) ); | |
} | |
/** | |
* Returns the filesystem path for a file/dir within this plugin. | |
* | |
* @param $path string The path within this plugin, e.g. '/js/clever-fx.js' | |
* @return string Filesystem path | |
* @author Simon Wheatley | |
**/ | |
protected function dir( $path ) { | |
return trailingslashit( $this->dir ) . trim( $path, '/' ); | |
} | |
/** | |
* Returns the URL for for a file/dir within this plugin. | |
* | |
* @param $path string The path within this plugin, e.g. '/js/clever-fx.js' | |
* @return string URL | |
* @author Simon Wheatley | |
**/ | |
protected function url( $path ) { | |
return esc_url( trailingslashit( $this->url ) . trim( $path, '/' ) ); | |
} | |
/** | |
* Gets the value of an option named as per this plugin. | |
* | |
* @return mixed Whatever | |
* @author Simon Wheatley | |
**/ | |
protected function get_all_options() { | |
return get_option( $this->name ); | |
} | |
/** | |
* Sets the value of an option named as per this plugin. | |
* | |
* @return mixed Whatever | |
* @author Simon Wheatley | |
**/ | |
protected function update_all_options( $value ) { | |
return update_option( $this->name, $value ); | |
} | |
/** | |
* Gets the value from an array index on an option named as per this plugin. | |
* | |
* @param string $key A string | |
* @return mixed Whatever | |
* @author Simon Wheatley | |
**/ | |
public function get_option( $key, $value = null ) { | |
$option = get_option( $this->name ); | |
if ( ! is_array( $option ) || ! isset( $option[ $key ] ) ) | |
return $value; | |
return $option[ $key ]; | |
} | |
/** | |
* Sets the value on an array index on an option named as per this plugin. | |
* | |
* @param string $key A string | |
* @param mixed $value Whatever | |
* @return bool False if option was not updated and true if option was updated. | |
* @author Simon Wheatley | |
**/ | |
protected function update_option( $key, $value ) { | |
$option = get_option( $this->name ); | |
$option[ $key ] = $value; | |
return update_option( $this->name, $option ); | |
} | |
/** | |
* Deletes the array index on an option named as per this plugin. | |
* | |
* @param string $key A string | |
* @return bool False if option was not updated and true if option was updated. | |
* @author Simon Wheatley | |
**/ | |
protected function delete_option( $key ) { | |
$option = get_option( $this->name ); | |
if ( isset( $option[ $key ] ) ) | |
unset( $option[ $key ] ); | |
return update_option( $this->name, $option ); | |
} | |
/** | |
* Echoes out some JSON indicating that stuff has gone wrong. | |
* | |
* @param string $msg The error message | |
* @return void | |
* @author Simon Wheatley | |
**/ | |
protected function ajax_die( $msg ) { | |
$data = array( 'msg' => $msg, 'success' => false ); | |
echo json_encode( $data ); | |
// N.B. No 500 header | |
exit; | |
} | |
/** | |
* Truncates a string in a human friendly way. | |
* | |
* @param string $str The string to truncate | |
* @param int $num_words The number of words to truncate to | |
* @return string The truncated string | |
* @author Simon Wheatley | |
**/ | |
protected function truncate( $str, $num_words ) | |
{ | |
$str = strip_tags( $str ); | |
$words = explode(' ', $str ); | |
if ( count( $words ) > $num_words) { | |
$k = $num_words; | |
$use_dotdotdot = 1; | |
} else { | |
$k = count( $words ); | |
$use_dotdotdot = 0; | |
} | |
$words = array_slice( $words, 0, $k ); | |
$excerpt = trim( join( ' ', $words ) ); | |
$excerpt .= ($use_dotdotdot) ? '…' : ''; | |
return $excerpt; | |
} | |
} // END GSAForWPMS_Plugin class | |
?> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
<?php | |
/* | |
Plugin Name: GSA For WordPress Multisite | |
Plugin URI: http://simonwheatley.co.uk/wordpress/gsa-for-wordpress-ms | |
Description: Handles the options required for integrating with WordPress Multisite | |
Network: true | |
Version: 0.1 | |
Author: <a href="http://simonwheatley.co.uk/wordpress/">Simon Wheatley</a> & <a href="http://www.sword-group.com/">Pablo Solera</a> | |
*/ | |
/* Copyright 2011 Simon Wheatley | |
This program is free software; you can redistribute it and/or modify | |
it under the terms of the GNU General Public License as published by | |
the Free Software Foundation; either version 2 of the License, or | |
(at your option) any later version. | |
This program is distributed in the hope that it will be useful, | |
but WITHOUT ANY WARRANTY; without even the implied warranty of | |
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
GNU General Public License for more details. | |
You should have received a copy of the GNU General Public License | |
along with this program; if not, write to the Free Software | |
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
*/ | |
/** | |
* @package GSA for WordPress Multisite | |
* @author Simon Wheatley | |
* @copyright Copyright (C) Simon Wheatley (except where noted) | |
**/ | |
require_once( 'class-plugin.php' ); | |
require_once( 'class-gsa-for-wp-ms.php' ); | |
?> |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment