> Read the accompanying readme.txt file for instructions and documentation.
=>> Also, visit the plugin's homepage for additional information and updates.
=>> Or visit: http://wordpress.org/extend/plugins/add-admin-javascript/
TODO:
* Move 'Advanced Tips' section to contextual help
*/
/*
Copyright (c) 2010-2011 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 ( is_admin() && ! class_exists( 'c2c_AddAdminJavaScript' ) ) :
require_once( 'c2c-plugin.php' );
class c2c_AddAdminJavaScript extends C2C_Plugin_029 {
public static $instance;
protected $jq = false; // To hold memoized jQuery code
/**
* Handles installation tasks, such as ensuring plugin options are instantiated and saved to options table.
*
* @return void
*/
public function __construct() {
$this->c2c_AddAdminJavaScript();
}
public function c2c_AddAdminJavaScript() {
// Be a singleton
if ( ! is_null( self::$instance ) )
return;
parent::__construct( '1.1', 'add-admin-javascript', 'c2c', __FILE__, array() );
register_activation_hook( __FILE__, array( __CLASS__, 'activation' ) );
self::$instance = $this;
}
/**
* Handles activation tasks, such as registering the uninstall hook.
*
* @since 1.1
*
* @return void
*/
public function activation() {
register_uninstall_hook( __FILE__, array( __CLASS__, 'uninstall' ) );
}
/**
* Handles uninstallation tasks, such as deleting plugin options.
*
* This can be overridden.
*
* @since 1.1
*
* @return void
*/
public function uninstall() {
delete_option( 'c2c_add_admin_javascript' );
}
/**
* Initializes the plugin's configuration and localizable text variables.
*
* @return void
*/
public function load_config() {
$this->name = __( 'Add Admin JavaScript', $this->textdomain );
$this->menu_name = __( 'Admin JavaScript', $this->textdomain );
$this->config = array(
'files' => array( 'input' => 'inline_textarea', 'default' => '', 'datatype' => 'array',
'label' => __( 'Admin JavaScript Files', $this->textdomain ),
'help' => __( 'List one URL per line. The reference can be relative to the root of your site, or a full, absolute URL. These will be listed in the order listed, and appear in the <head> before the JS defined below.', $this->textdomain ),
'input_attributes' => 'rows="8" cols="40"'
),
'js_head' => array( 'input' => 'textarea', 'default' => '', 'datatype' => 'text',
'label' => __( 'Admin JavaScript (in head)', $this->textdomain ),
'help' => __( 'Note that the above JavaScript will be added to all admin pages and apply for all admin users.', $this->textdomain ),
'input_attributes' => 'rows="8" cols="40"'
),
'js_foot' => array( 'input' => 'textarea', 'default' => '', 'datatype' => 'text',
'label' => __( 'Admin JavaScript (in footer)', $this->textdomain ),
'help' => __( 'Note that the above JavaScript will be added to all admin pages and apply for all admin users. To speed up page load, it is recommended that inline JavaScript be added to the footer instead of the head.', $this->textdomain ),
'input_attributes' => 'rows="8" cols="40"'
),
'js_jq' => array( 'input' => 'textarea', 'default' => '', 'datatype' => 'text',
'label' => __( 'Admin jQuery JavaScript', $this->textdomain ),
'help' => __( 'This will be put in a jQuery(document).ready(function($)) {} in the footer. Note that the above JavaScript will be added to all admin pages and apply for all admin users.', $this->textdomain ),
'input_attributes' => 'rows="8" cols="40"'
)
);
}
/**
* Override the plugin framework's register_filters() to register actions and filters.
*
* @return void
*/
public function register_filters() {
add_action( 'admin_enqueue_scripts', array( &$this, 'enqueue_js' ) );
add_action( 'admin_head', array( &$this, 'add_js_to_head' ) );
add_action( 'admin_print_footer_scripts', array( &$this, 'add_js_to_foot' ) );
add_action( $this->get_hook( 'after_settings_form' ), array( &$this, 'advanced_tips' ) );
}
/**
* Outputs the text above the setting form
*
* @return void (Text will be echoed.)
*/
public function options_page_description() {
parent::options_page_description( __( 'Add Admin JavaScript Settings', $this->textdomain ) );
echo '' . __( 'Add additional JavaScript to your admin pages.', $this->textdomain ) . '
';
echo '' . __( 'See Advanced Tips for info on how to use the plugin to programmatically customize JavaScript.' ) . '
';
}
/*
* Outputs advanced tips text
*
* @return void (Text will be echoed.)
*/
public function advanced_tips() {
echo '';
echo 'Advanced Tips
';
echo '' . __( 'You can also programmatically add to or customize any JavaScript defined in the "Admin JavaScript" field via the c2c_add_admin_js_jq filter, like so:', $this->textdomain ) . '
';
echo <<add_filter( 'c2c_add_admin_js_jq', 'my_admin_js_jq' );
function my_admin_js_jq( \$js ) {
\$js .= "
\$js_jq .= "$('.hide_me').hide();";
return \$js_jq;
";
return \$js;
}
HTML;
echo '' . __( 'You can also programmatically add to or customize any referenced JavaScript files defined in the "Admin JS Files" field via the c2c_add_admin_js_files filter, like so:', $this->textdomain ) . '
';
echo <<add_filter( 'c2c_add_admin_js_files', 'my_admin_js_files' );
function my_admin_js_files( \$files ) {
\$files[] = 'http://ajax.googleapis.com/ajax/libs/yui/2.8.1/build/yuiloader/yuiloader-min.js';
return \$files;
}
HTML;
echo '' . __( 'In addition, the "Admin JavaScript (in head)" and "Admin JavaScript (in footer)" can be filtered via c2c_add_admin_js_head and c2c_add_admin_js_footer respectively.', $this->textdomain ) . "
\n";
}
/**
* Obtain the jQuery JavaScript, if any. Needed since it is requested in two
* functions so it should be memoizable.
*/
public function get_jq() {
$options = $this->get_options();
if ( $this->jq === false || empty( $this->jq ) )
$this->jq = trim( apply_filters( 'c2c_add_admin_js_jq', $options['js_jq'] . "\n" ) );
return $this->jq;
}
/**
* Enqueues javascript.
*
* @return void
*/
public function enqueue_js() {
$options = $this->get_options();
if ( $this->get_jq() != '' )
wp_enqueue_script( 'jquery' );
$files = (array) apply_filters( 'c2c_add_admin_js_files', $options['files'] );
if ( $files ) {
foreach ( $files as $file )
wp_enqueue_script( $this->id_base, $file, array(), $this->version, true );
}
}
/**
* Outputs JavaScript as header links and/or inline header code
*
* @return void (Text will be echoed.)
*/
public function add_js_to_head() {
$options = $this->get_options();
$js = trim( apply_filters( 'c2c_add_admin_js_head', $options['js_head'] . "\n" ) );
if ( ! empty( $js ) ) {
echo "
";
}
}
/**
* Outputs JavaScript into footer as regular JavaScript and/or within a jQuery ready
*
* @return void (Text will be echoed.)
*/
public function add_js_to_foot() {
$options = $this->get_options();
$js = trim( apply_filters( 'c2c_add_admin_js_footer', $options['js_foot'] . "\n" ) );
if ( ! empty( $js ) ) {
echo "
";
}
$js = $this->get_jq();
if ( ! empty( $js ) ) {
echo "
";
}
}
} // end c2c_AddAdminJavaScript
new c2c_AddAdminJavaScript();
endif; // end if !class_exists()
?>