> Read the accompanying readme.txt file for more information. Also, visit the plugin's homepage =>> for more information and the latest updates Installation: */ /* Copyright (c) 2010 by Scott Reilly (aka coffee2code) Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ if ( !class_exists( 'C2C_Plugin_012' ) ) : class C2C_Plugin_012 { var $plugin_css_version = '006'; var $options = array(); var $option_names = array(); var $required_config = array( 'menu_name', 'name' ); var $saved_settings = false; var $saved_settings_msg = ''; /** * Handles installation tasks, such as ensuring plugin options are instantiated and saved to options table. * * @param string $version Version of the plugin. * @param string $id_base A unique base ID for the plugin (generally a lower-case, dash-separated version of plugin name). * @param string $author_prefix Short (2-3 char) identifier for plugin author. * @param string $file The __FILE__ value for the sub-class. * @param array $plugin_options (optional) Array specifying further customization of plugin configuration. * @return void */ function C2C_Plugin_012( $version, $id_base, $author_prefix, $file, $plugin_options = array() ) { global $pagenow; $id_base = sanitize_title( $id_base ); if ( !file_exists( $file ) ) die( sprintf( __( 'Invalid file specified for C2C_Plugin: %s', $this->textdomain ), $file ) ); $u_id_base = str_replace( '-', '_', $id_base ); $author_prefix .= '_'; $defaults = array( 'admin_options_name' => $author_prefix . $u_id_base, // The setting under which all plugin settings are stored under (as array) 'config' => array(), // Default configuration 'disable_contextual_help' => false, // Prevent overriding of the contextual help? 'disable_update_check' => false, // Prevent WP from checking for updates to this plugin? 'hook_prefix' => $u_id_base . '_', // Prefix for all hooks 'form_name' => $u_id_base, // Name for the

'menu_name' => '', // Specify this via plugin 'name' => '', // Full, localized version of the plugin name 'nonce_field' => 'update-' . $u_id_base, // Nonce field value 'settings_page' => 'options-general', // The type of the settings page. 'show_admin' => true, // Should admin be shown? Only applies if admin is enabled 'textdomain' => $id_base, // Textdomain for localization 'textdomain_subdir' => 'lang' // Subdirectory, relative to plugin's root, to hold localization files ); $settings = wp_parse_args( $plugin_options, $defaults ); foreach ( array_keys( $defaults ) as $key ) $this->$key = $settings[$key]; $this->author_prefix = $author_prefix; $this->id_base = $id_base; $this->options_page = ''; // This will be set when the options is created $this->plugin_basename = plugin_basename( $file ); $this->plugin_file = $file; $this->plugin_path = plugins_url( '', $file ); $this->u_id_base = $u_id_base; // Underscored version of id_base $this->version = $version; add_action( 'init', array( &$this, 'init' ) ); $plugin_file = implode( '/', array_slice( explode( '/', $this->plugin_basename ), -2 ) ); add_action( 'activate_' . $plugin_file, array( &$this, 'install' ) ); add_action( 'deactivate_' . $plugin_file, array( &$this, 'deactivate' ) ); register_uninstall_hook( $this->plugin_file, array( &$this, 'uninstall' ) ); add_action( 'admin_init', array( &$this, 'init_options' ) ); if ( basename( $pagenow, '.php' ) == $this->settings_page ) add_action( 'admin_head', array( &$this, 'add_c2c_admin_css' ) ); } /** * Handles installation tasks, such as ensuring plugin options are instantiated and saved to options table. * * This can be overridden. * * @return void */ function install() { $this->options = $this->get_options(); update_option( $this->admin_options_name, $this->options ); } /** * Handles uninstallation tasks, such as deleting plugin options. * * This can be overridden. * * @return void */ function uninstall() { delete_option( $this->admin_options_name ); } /** * Handles actions to be hooked to 'init' action, such as loading text domain and loading plugin config data array. * * @return void */ function init() { global $c2c_plugin_max_css_version; if ( !isset( $c2c_plugin_max_css_version ) || ( $c2c_plugin_max_css_version < $this->plugin_css_version ) ) $c2c_plugin_max_css_version = $this->plugin_css_version; $this->load_textdomain(); $this->load_config(); $this->verify_config(); if ( $this->disable_update_check ) add_filter( 'http_request_args', array( &$this, 'disable_update_check' ), 5, 2 ); if ( $this->show_admin && $this->settings_page && !empty( $this->config ) && current_user_can( 'manage_options' ) ) { add_action( 'admin_menu', array( &$this, 'admin_menu' ) ); if ( !$this->disable_contextual_help ) { add_action( 'contextual_help', array( &$this, 'contextual_help' ), 10, 3 ); if ( $this->is_plugin_admin_page() ) add_thickbox(); } } $this->register_filters(); } /** * Prevents this plugin from being included when WordPress phones home * to check for plugin updates. * * @param array $r Response array * @param string $url URL for the update check * @return array The response array with this plugin removed, if present */ function disable_update_check( $r, $url ) { if ( 0 !== strpos( $url, 'http://api.wordpress.org/plugins/update-check' ) ) return $r; // Not a plugin update request. Bail immediately. $plugins = unserialize( $r['body']['plugins'] ); unset( $plugins->plugins[ plugin_basename( __FILE__ ) ] ); unset( $plugins->active[ array_search( plugin_basename( __FILE__ ), $plugins->active ) ] ); $r['body']['plugins'] = serialize( $plugins ); return $r; } /** * Initializes options * * @return void */ function init_options() { register_setting( $this->admin_options_name, $this->admin_options_name, array( &$this, 'sanitize_inputs' ) ); add_settings_section( 'default', '', array( &$this, 'draw_default_section' ), $this->plugin_file ); add_filter( 'whitelist_options', array( &$this, 'whitelist_options' ) ); foreach ( $this->get_option_names( false ) as $opt ) add_settings_field( $opt, $this->get_option_label( $opt ), array( &$this, 'display_option' ), $this->plugin_file, 'default', $opt ); } /** * Whitelist the plugin's option(s) * * @param array $options Array of options * @return array The whitelist-amended $options array */ function whitelist_options( $options ) { $added = array( $this->admin_options_name => array( $this->admin_options_name ) ); $options = add_option_whitelist( $added, $options ); return $options; } /** * Special output for the default section. Can be overridden if desired. * * @return void */ function draw_default_section() { } /** * Gets the label for a given option * * @param string $opt The option * @return string The label for the option */ function get_option_label( $opt ) { return isset( $this->config[$opt]['label'] ) ? $this->config[$opt]['label'] : ''; } /** * Sanitize user inputs prior to saving */ function sanitize_inputs( $inputs ) { do_action( $this->get_hook( 'before_save_options' ), $this ); if ( isset( $_POST['Reset'] ) ) { $options = $this->get_options( false ); add_settings_error( 'general', 'settings_reset', __( 'Settings reset.', $this->textdomain ), 'updated' ); } else { // Start with the existing options, then start overwriting their potential override value. (This prevents // unscrupulous addition of fields by the user) $options = $this->get_options(); $option_names = $this->get_option_names(); foreach ( $option_names as $opt ) { if ( !isset( $inputs[$opt] ) ) { if ( $this->config[$opt]['input'] == 'checkbox' ) $options[$opt] = ''; elseif ( ( $this->config[$opt]['required'] === true ) ) { $msg = sprintf( __( 'A value is required for: "%s"', $this->textdomain ), $this->config[$opt]['label'] ); add_settings_error( 'general', 'setting_required', $msg, 'error' ); } } else { $val = $inputs[$opt]; $error = false; if ( empty( $val ) && ( $this->config[$opt]['required'] === true ) ) { $msg = sprintf( __( 'A value is required for: "%s"', $this->textdomain ), $this->config[$opt]['label'] ); $error = true; } else { $input = $this->config[$opt]['input']; switch ( $this->config[$opt]['datatype'] ) { case 'checkbox': break; case 'int': if ( !empty( $val ) && ( !is_numeric( $val ) || ( intval( $val ) != round( $val ) ) ) ) { $msg = sprintf( __( 'Expected integer value for: %s', $this->textdomain ), $this->config[$opt]['label'] ); $error = true; } break; case 'array': if ( empty( $val ) ) $val = array(); elseif ( $input == 'text' ) $val = explode( ',', str_replace( array( ', ', ' ', ',' ), ',', $val ) ); else $val = array_map( 'trim', explode( "\n", trim( $val ) ) ); break; case 'hash': if ( !empty( $val ) && $input != 'select' ) { $new_values = array(); foreach ( explode( "\n", $val ) AS $line ) { list( $shortcut, $text ) = array_map( 'trim', explode( "=>", $line, 2 ) ); if ( !empty( $shortcut ) ) $new_values[str_replace( '\\', '', $shortcut )] = str_replace( '\\', '', $text ); } $val = $new_values; } break; } } if ( $error ) add_settings_error( 'general', 'setting_not_int', $msg, 'error' ); $options[$opt] = $val; } } $options = apply_filters( $this->get_hook( 'before_update_option' ), $options, $this ); } return $options; } /** * Initializes the plugin's configuration and localizable text variables. * * @return void */ function load_config() { die( 'Function load_config() must be overridden in sub-class.' ); } /** * Verify that the necessary configuration files were set in the inheriting class. * * @return void */ function verify_config() { // Ensure required configuration options have been configured via the sub-class. Die if any aren't. foreach ( $this->required_config as $config ) { if ( empty( $this->$config ) ) die( "The plugin configuration option '$config' must be supplied." ); } // Set/change configuration options based on sub-class changes. if ( empty( $this->config ) ) $this->show_admin = false; else { // Initialize any option attributes that weren't specified by the plugin foreach ( $this->get_option_names( true ) as $opt ) { foreach ( array( 'datatype', 'default', 'help', 'input', 'input_attributes', 'label', 'no_wrap', 'options', 'output' ) as $attrib ) { if ( !isset( $this->config[$opt][$attrib] ) ) $this->config[$opt][$attrib] = ''; } $this->config[$opt]['allow_html'] = false; $this->config[$opt]['class'] = array(); } } } /** * Loads the localization textdomain for the plugin. * * @return void */ function load_textdomain() { $subdir = empty( $this->textdomain_subdir ) ? '' : '/'.$this->textdomain_subdir; load_plugin_textdomain( $this->textdomain, false, basename( dirname( $this->plugin_file ) ) . $subdir ); } /** * Registers filters. * NOTE: This occurs during the 'init' filter, so you can't use this to hook anything that happens earlier * * @return void */ function register_filters() { // This should be overridden in order to define filters. } /** * Outputs simple contextual help text, comprising solely of a thickboxed link to the plugin's hosted readme.txt file. * * NOTE: If overriding this in a sub-class, before sure to include the * check at the beginning of the function to ensure it shows up on its * own settings admin page. * * @param string $contextual_help The default contextual help * @param int $screen_id The screen ID * @param object $screen The screen object * @return void (Text is echoed) */ function contextual_help( $contextual_help, $screen_id, $screen ) { if ( $screen_id != $this->options_page ) return $contextual_help; $help_url = admin_url( "plugin-install.php?tab=plugin-information&plugin={$this->id_base}&TB_iframe=true&width=640&height=656" ); echo '

'; echo '' . __( 'Click for more help on this plugin', $this->textdomain ) . '' . __( ' (especially check out the "Other Notes" tab, if present)', $this->textdomain ); echo ".

\n"; return; } /** * Outputs CSS into admin head of the plugin's settings page * * @return void */ function add_c2c_admin_css() { global $c2c_plugin_max_css_version, $c2c_plugin_css_was_output; if ( ( $c2c_plugin_max_css_version != $this->plugin_css_version ) || ( isset( $c2c_plugin_css_was_output ) && $c2c_plugin_css_was_output ) ) return; $c2c_plugin_css_was_output = true; $logo = plugins_url( 'c2c_minilogo.png', $this->plugin_file ); /** * Remember to increment the plugin_css_version variable if changing the CSS */ echo << .long-text {width:95% !important;} #c2c { text-align:center; color:#888; background-color:#ffffef; padding:5px 0 0; margin-top:12px; border-style:solid; border-color:#dadada; border-width:1px 0; } #c2c div { margin:0 auto; padding:5px 40px 0 0; width:45%; min-height:40px; background:url('$logo') no-repeat top right; } #c2c span { display:block; font-size:x-small; } .form-table {margin-bottom:20px;} .c2c-plugin-list {margin-left:2em;} .c2c-plugin-list li {list-style:disc outside;} .wrap {margin-bottom:30px !important;} .c2c-form input[type="checkbox"] {width:1.5em;} .c2c-form .hr, .c2c-hr {border-bottom:1px solid #ccc;padding:0 2px;margin-bottom:6px;} .c2c-input-help {color:#777;font-size:x-small;} .c2c-fieldset {border:1px solid #ccc; padding:2px 8px;} .c2c-textarea, .c2c-inline_textarea {width:95%;font-family:"Courier New", Courier, mono;} .c2c-nowrap { white-space:nowrap;overflow:scroll;overflow-y:hidden;overflow-x:scroll;overflow:-moz-scrollbars-horizontal } .see-help {font-size:x-small;font-style:italic;} .more-help {display:block;margin-top:8px;} CSS; } /** * Registers the admin options page and the Settings link. * * @return void */ function admin_menu() { add_filter( 'plugin_action_links_' . $this->plugin_basename, array( &$this, 'plugin_action_links' ) ); switch ( $this->settings_page ) { case 'options-general' : $func_root = 'options'; break; case 'themes' : $func_root = 'theme'; break; default : $func_root = $this->settings_page; } $menu_func = 'add_' . $func_root . '_page'; if ( function_exists( $menu_func ) ) $this->options_page = call_user_func( $menu_func, $this->name, $this->menu_name, 'manage_options', $this->plugin_basename, array( &$this, 'options_page' ) ); } /** * Adds a 'Settings' link to the plugin action links. * * @param int $limit The default limit value for the current posts query. * @return array Links associated with a plugin on the admin Plugins page */ function plugin_action_links( $action_links ) { $settings_link = '' . __( 'Settings', $this->textdomain ) . ''; array_unshift( $action_links, $settings_link ); return $action_links; } /** * Returns the list of option names. * * @param bool $include_non_options (optional) Should non-options be included? Default is false. * @return array Array of option names. */ function get_option_names( $include_non_options = false ) { if ( !$include_non_options && !empty( $this->option_names ) ) return $this->option_names; if ( $include_non_options ) return array_keys( $this->config ); $this->option_names = array(); foreach ( array_keys( $this->config ) as $opt ) { if ( isset( $this->config[$opt]['input'] ) && $this->config[$opt]['input'] != '' && $this->config[$opt]['input'] != 'none' ) $this->option_names[] = $opt; } return $this->option_names; } /** * Returns either the buffered array of all options for the plugin, or * obtains the options and buffers the value. * * @param bool $with_current_values (optional) Should the currently saved values be returned? If false, then the plugin's defaults are returned. Default is true. * @return array The options array for the plugin (which is also stored in $this->options if !$with_options). */ function get_options( $with_current_values = true ) { if ( $with_current_values && !empty( $this->options ) ) return $this->options; // Derive options from the config $options = array(); foreach ( $this->get_option_names() as $opt ) $options[$opt] = $this->config[$opt]['default']; if ( !$with_current_values ) return $options; $this->options = wp_parse_args( get_option( $this->admin_options_name ), $options ); // Un-escape fields foreach ( $this->get_option_names() as $opt ) { if ( $this->config[$opt]['allow_html'] == true ) { if ( is_array( $this->options[$opt] ) ) { foreach ( $this->options[$opt] as $key => $val ) { $new_key = wp_specialchars_decode( $key, ENT_QUOTES ); $new_val = wp_specialchars_decode( $val, ENT_QUOTES ); $this->options[$opt][$new_key] = $new_val; if ( $key != $new_key ) unset( $this->options[$opt][$key] ); } } else { $this->options[$opt] = wp_specialchars_decode( $this->options[$opt], ENT_QUOTES ); } } } return apply_filters( $this->get_hook( 'options' ), $this->options ); } /** * Checks if the plugin's settings page has been submitted. * * @param string $prefix The prefix for the form's unique submit hidden input field * @return bool True if the plugin's settings have been submitted for saving, else false. */ function is_submitting_form( $prefix ) { return ( isset( $_POST['option_page'] ) && ( $_POST['option_page'] == $this->admin_options_name ) ); } /** * Checks if the current page is the plugin's settings page. * * @return bool True if on the plugin's settings page, else false. */ function is_plugin_admin_page() { global $pagenow; return ( basename( $pagenow, '.php' ) == $this->settings_page && isset( $_REQUEST['page'] ) && $_REQUEST['page'] == $this->plugin_basename ); } /** * Outputs the markup for an option's form field (and surrounding markup) * * @param string $opt The name/key of the option. * @return void */ function display_option( $opt ) { global $wp_version; do_action( $this->get_hook( 'pre_display_option' ), $opt ); $options = $this->get_options(); // See if the setting is pertinent to this version of WP $ver_operators = array( 'wpgt' => '>', 'wpgte' => '>=', 'wplt' => '<', 'wplte' => '<=' ); foreach ( $ver_operators as $ver_check => $ver_op ) { if ( isset( $this->config[$opt][$ver_check] ) && !empty( $this->config[$opt][$ver_check] ) ) { if ( !version_compare( $wp_version, $this->config[$opt][$ver_check], $ver_op ) ) return; } } foreach ( array( 'datatype', 'input' ) as $attrib ) $$attrib = isset( $this->config[$opt][$attrib] ) ? $this->config[$opt][$attrib] : ''; if ( $input == '' || $input == 'none' ) return; elseif ( $input == 'custom' ) { do_action( $this->get_hook( 'custom_display_option' ), $opt ); return; } $value = isset( $options[$opt] ) ? $options[$opt] : ''; $popt = $this->admin_options_name . "[$opt]"; if ( $input == 'multiselect' ) { // Do nothing since it needs the values as an array $popt .= '[]'; } elseif ( $datatype == 'array' ) { if ( !is_array( $value ) ) $value = ''; else { if ( $input == 'textarea' || $input == 'inline_textarea' ) $value = implode( "\n", $value ); else $value = implode( ', ', $value ); } } elseif ( $datatype == 'hash' && $input != 'select' ) { if ( !is_array( $value ) ) $value = ''; else { $new_value = ''; foreach ( $value AS $shortcut => $replacement ) $new_value .= "$shortcut => $replacement\n"; $value = $new_value; } } $attributes = $this->config[$opt]['input_attributes']; $this->config[$opt]['class'][] = 'c2c-' . $input; if ( ( 'textarea' == $input || 'inline_textarea' == $input ) && $this->config[$opt]['no_wrap'] ) { $this->config[$opt]['class'][] = 'c2c-nowrap'; $attributes .= ' wrap="off"'; // Unfortunately CSS is not enough } elseif ( in_array( $input, array( 'text', 'long_text', 'short_text' ) ) ) { $this->config[$opt]['class'][] = ( ( $input == 'short_text' ) ? 'small-text' : 'regular-text' ); if ( $input == 'long_text' ) $this->config[$opt]['class'][] = ' long-text'; } $class = implode( ' ', $this->config[$opt]['class'] ); $attribs = "name='$popt' id='$opt' class='$class' $attributes"; if ( $input == '' ) { // Change of implementation prevents this from being possible (since this function only gets called for registered settings) // if ( !empty( $this->config[$opt]['output'] ) ) // echo $this->config[$opt]['output'] . "\n"; // else // echo '

' . "\n"; } elseif ( $input == 'textarea' || $input == 'inline_textarea' ) { if ( $input == 'textarea' ) echo ""; echo "\n"; } elseif ( $input == 'select' ) { echo ""; } elseif ( $input == 'multiselect' ) { echo '

' . "\n"; foreach ( (array) $this->config[$opt]['options'] as $sopt ) echo "$sopt
\n"; echo '

'; } elseif ( $input == 'checkbox' ) { echo "\n"; } else { echo "\n"; } if ( $help = apply_filters( $this->get_hook( 'option_help'), $this->config[$opt]['help'], $opt ) ) echo "
$help\n"; do_action( $this->get_hook( 'post_display_option' ), $opt ); } /** * Outputs the descriptive text (and h2 heading) for the options page. * * Intended to be overridden by sub-class. * * @param string $localized_heading_text (optional) Localized page heading text. * @return void */ function options_page_description( $localized_heading_text = '' ) { if ( empty( $localized_heading_text ) ) $localized_heading_text = $this->name; if ( $localized_heading_text ) echo '

' . $localized_heading_text . "

\n"; if ( !$this->disable_contextual_help ) echo '

' . __( 'See the "Help" link to the top-right of the page for more help.', $this->textdomain ) . "

\n"; } /** * Outputs the options page for the plugin, and saves user updates to the * options. * * @return void */ function options_page() { $options = $this->get_options(); if ( $this->saved_settings ) echo "

" . $this->saved_settings_msg . '

'; $logo = plugins_url( basename( $_GET['page'], '.php' ) . '/c2c_minilogo.png' ); echo "

\n"; echo "

textdomain ) . "' />

\n"; $this->options_page_description(); do_action( $this->get_hook( 'before_settings_form' ), $this ); echo "\n"; settings_fields( $this->admin_options_name ); do_settings_sections( $this->plugin_file ); echo '' . "\n"; echo '' . "\n"; echo '' . "\n"; do_action( $this->get_hook( 'after_settings_form' ), $this ); echo '

' . "\n"; $c2c = '' . __( 'Scott Reilly, aka coffee2code', $this->textdomain ) . ''; echo sprintf( __( 'This plugin brought to you by %s.', $this->textdomain ), $c2c ); echo '' . __( 'Did you find this plugin useful?', $this->textdomain ) . ''; echo '

' . "\n"; } /** * Returns the full plugin-specific name for a hook. * * @param string $hook The name of a hook, to be made plugin-specific. * @return string The plugin-specific version of the hook name. */ function get_hook( $hook ) { return $this->hook_prefix . '_' . $hook; } /** * Returns the URL for the plugin's readme.txt file on wordpress.org/extend/plugins * * @since 005 * * @return string The URL */ function readme_url() { return 'http://wordpress.org/extend/plugins/' . $this->id_base . '/tags/' . $this->version . '/readme.txt'; } } // end class endif; // end if !class_exists() ?>