coffee2code

Extended Description

Installation

Filters

The plugin exposes four filters for hooking. Typically, these customizations would be put into your active theme’s functions.php file, or used by another plugin.

c2c_add_admin_js_files (filter)

The ‘c2c_add_admin_js_files’ hook allows you to programmatically add to or
customize any referenced JavaScript files defined in the “Admin JavaScript Files” field.

Arguments:

• $files (array): Array of JavaScript files

Example:

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;
}

c2c_add_admin_js_head (filter)

The ‘c2c_add_admin_js_head’ hook allows you to programmatically add to or
customize any JavaScript to be put into the page head as defined in the
“Admin JavaScript (in head)” field.

Arguments:

• $js (string): JavaScript

Example:

add_filter( 'c2c_add_admin_js_head', 'my_add_head_js' );
function my_add_head_js( $js ) {
    $js .= "alert('Hello');";
    return $js;
}

c2c_add_admin_js_footer (filter)

The ‘c2c_add_admin_js_footer’ hook allows you to programmatically add to or
customize any JavaScript to be put into the page head as defined in the
“Admin JavaScript (in footer)” field.

Arguments:

• $js (string): JavaScript

Example:

add_filter( 'c2c_add_admin_js_footer', 'my_add_footer_js' );
function my_add_footer_js( $js ) {
    $js .= "alert('Hello');";
    return $js;
}

c2c_add_admin_js_jq (filter)

The ‘c2c_add_admin_js_jq’ hook allows you to filter the jQuery JavaScript to be output in the footer of admin pages.
The ‘c2c_add_admin_js_jq’ hook allows you to programmatically add to or
customize any jQuery JS to be put into the page footer as defined in the
“Admin jQuery JavaScript” field.

Arguments:

• $js_jq (string): String of jQuery JavaScript

Example:

add_filter( 'c2c_add_admin_js_jq', 'my_add_jq' );
function my_add_jq( $js_jq ) {
    $js_jq .= "$('.hide_me').hide();";
    return $js_jq;
}

Frequently Asked Questions

Q. Can I add JavaScript I defined via a file, or one that is hosted elsewhere?
A. Yes, via the “Admin JavaScript Files” input field on the plugin’s settings page.

Q. Can I limit what admin pages the JavaScript gets output on?
A. No, not presently. The JavaScript is added to every admin page on the site.

However, you can preface your selectors with admin page specific class(es) on ‘body’ tag to ensure CSS only applies on certain admin pages. (e.g. jQuery('body.index-php h2').hide();).

Q. Can I limit what users the JavaScript applies to?
A. No, not presently. The JavaScript is added for any user that can enter the admin section of the site.

Release Log

1.2

• Move ‘Advanced Tips’ section from bottom of settings page into contextual help section
• Add help_tabs_content() and contextual_help()
• Prevent textareas from wrapping lines
• Change input fields to be displayed as inline_textarea instead of textarea
• Add instance() static method for returning/creating singleton instance
• Made static variable ‘instance’ private
• Add dummy __clone() and __wakeup()
• Remove support for previously deprecated ‘c2c_add_admin_css’ global
• Remove c2c_AddAdminCSS(); only PHP5 constructor is supported now
• Update plugin framework to 035
• Discontinue use of explicit pass-by-reference for objects
• Add check to prevent execution of code if file is directly accessed
• Regenerate .pot
• Re-license as GPLv2 or later (from X11)
• Add ‘License’ and ‘License URI’ header tags to readme.txt and plugin file
• Minor documentation improvements
• Note compatibility through WP 3.5+
• Drop compatibility versions of WP older than 3.1
• Update copyright date (2013)
• Minor code reformatting (spacing)
• Remove ending PHP close tag
• Create repo’s WP.org assets directory
• Move screenshot into repo’s assets directory

1.1.1

• Fix typo in code example in Advanced Tips
• Add addition help text for js_head to indicate use of js_foot is preferred
• Update .pot
• Update screenshot

1.1

• Update plugin framework to 029
• Save a static version of itself in class variable $instance
• Discontinue use of global variable $c2c_add_admin_js to store instance
• Explicitly declare all functions as public
• Add __construct(), activation(), and uninstall()
• Note compatibility through WP 3.3+
• Drop compatibility with versions of WP older than 3.0
• Expand most onscreen and documentation references from “JS” to “JavaScript”
• Add .pot
• Add screenshot
• Add ‘Domain Path’ plugin header
• Tweak description
• Minor code formatting changes (spacing)
• Update copyright date (2011)
• Add plugin homepage and author links in description in readme.txt

1.0

• Initial release (not publicly released)

Copyright & Disclaimer