Skip to main content
  1. All Posts/

cfc-dev-tools

Tools Open Source PHP WordPress

CFC Development Tools for WordPress

This WordPress plugin allows you to easily place various development notes throughout your website. The development notes will appear on your page and the browser’s console only when:

  • You have WP_DEBUG set to true in your wp-config.php file. This allows you to prevent the display of development notes on a production server if you wish.
  • You are logged into WordPress as an Administrator.
  • ?devnote is appended to the URL. (http://domain.com/page/?devnote)

FEATURES:

  • Allows you to add development notes which appear on your page and in the browser’s console.
  • Display in the page’s footer the total number of SQL queries performed on the page and the total time required to generate the page.
  • Basic PHP profiling in the browser’s console.
  • Colour-coded CSS debugging using https://github.com/mrmrs/pesticide/

INSTALLATION:

  1. Place in /wp-content/mu-plugins/ folder.
  2. Make sure WP_DEBUG and SAVEQUERIES constants are defined in your wp-config.php file.
    define(‘WP_DEBUG’, true );
    define(‘SAVEQUERIES’, true );

Use https://github.com/cleanforestco/wp-config/blob/master/wp-config.php as a reference.

SUBLIME TEXT:

For those who use the excellent Sublime Text editor, there is also a snippet included which enables you to type devnote and then press the tab key for quickly inserting development notes. Please reference the Sublime Text documentation for instructions on how to install and manage snippets.

USAGE:

  1. Add Development Notes:

Display a development note on the website:

<?php devnote('Here is a development note'); ?>

Display structured information about an array using var_dump()

<?php $array = array("foo", "bar"); ?>
<?php devnote($array); ?>

Optionally, pass a second parameter, false, to prevent the development note from displaying on your page. The development note will show in the browser’s console only:

 <?php devnote('This will only display in the console', false); ?>
  1. Display development notes by appending ?devnote to any page:

E.g., http://localhost/about-us/?devnote