DEVELOPER-DOCS.md

Developer Documentation

This plugin provides hooks for developer usage.

Hooks

The plugin exposes a number of filters for hooking. Code using these filters should ideally be put into a mu-plugin or site-specific plugin (which is beyond the scope of this readme to explain).

c2c_add_admin_css (filter)

The c2c_add_admin_css filter allows customization of CSS that should be added directly to the admin page head.

Arguments

• $css (string) : CSS styles.

Example

/**
 * Add CSS to admin pages.
 *
 * @param string $css String to be added to admin pages.
 * @return string
 */
function my_admin_css( $css ) {
	$css .= "
		#site-heading a span { color:blue !important; }
		#favorite-actions { display:none; }
	";
	return $css;
}
add_filter( 'c2c_add_admin_css', 'my_admin_css' );

c2c_add_admin_css_files (filter)

The c2c_add_admin_css_files filter allows programmatic modification of the list of CSS files to enqueue in the admin.

Arguments

• $files (string) : Array of CSS files.

Example

/**
 * Add CSS file(s) to admin pages.
 *
 * @param array $files CSS files to be added to admin pages.
 * @return array
 */
function my_admin_css_files( $files ) {
	$files[] = 'http://yui.yahooapis.com/2.9.0/build/reset/reset-min.css';
	return $files;
}
add_filter( 'c2c_add_admin_css_files', 'my_admin_css_files' );

c2c_add_admin_css_disable_css (filter)

The c2c_add_admin_css_disable_css filter allows programmatic determination of whether output of the CSS defined via this plugin should be disabled or not.

Arguments

• $disable (bool) : Whether or not output of the CSS defined via this plugin should be disabled or not. True if CSS output should be disabled, else false. Default false.

Example

/**
 * Only output CSS from Add Admin CSS for admins.
 *
 * @param bool $disable Should CSS output be disabled?
 * @return bool
 */
function my_limit_add_admin_css_to_admins( $disable ) {
	if ( ! current_user_can( 'manage_options' ) ) {
		$disable = true;
	}
	return $disable;
}
add_filter( 'c2c_add_admin_css_disable_css', 'my_limit_add_admin_css_to_admins' );