Changeset 389436

Timestamp:

05/26/2011 04:15:59 PM (15 years ago)

Author:

kunalb

Message:

Updated the README.

Location:

kb-debug/trunk

Files:

• README (modified) (1 diff)
• kb_debug.php (modified) (1 diff)

kb-debug/trunk/README

@@ -1 @@
-KB_Debug
-========
+=== kb_debug.php  ===
+Contributors: kunalb
+Tags: Debugging
+Requires at least: WordPress 3.0
+Tested up to: 3.2
+Stable tag: 0.1
 
-A swiss army knife for debugging WordPress/BuddyPress plugins.
+Debug your plugins and themes.
 
-Drop this into wp-content/mu-plugins/ to start logging notices and warnings and displaying them.
+== Description ==
 
-WP_DEBUG must be set to true for anything to display.
+To log and show a list of all warnings, errors and notices generated by your plugin, add a ?KB_Debug_Errors to your URL. To see a list of all hooks in the order they fire as well as what arguments they are called with and what functions run on them (again, in which order), add a ?KB_Debug_Hooks to the URL.
 
-DO NOT USE THIS ON PRODUCTION SITES.
+To see both just add ?KB_Debug_Errors&KB_Debug_Hooks. (Essentially $_GET[var] must be set to enable that feature).
 
-Set the following constants anywhere in your code to display:
 
-# KB_DISPLAY_HOOKS Set to true to display hooks, as well as functions called with arguments. Only use with modern browsers that can handle lots of data.
-# KB_FORCE_HIDE Sometimes, you might not want to display anything. Setting this to true ensures that nothing is displayed.
+== Installation ==
 
+Upload `kb_debug.php` and 'kb-debug.css' to the `/wp-content/mu-plugins/` directory. (Create this directory if it doesn't exist).
+
+
+== Features ==
+* Logs and displays all warnings, errors, etc. alongwith their context.
+* Logs and displays all hooks alongwith the argument(s) each hook is called with and the functions that run on that particular hook (in order).
+
+== Frequently Asked Questions ==
+
+= Why? =
+Because.
+
+== Screenshots ==
+None yet.
+
+== Changelog ==
+
+= 0.2 =
+* Plugin completely refactored.
+* No longer uses buffering.
+* Features are now activated by setting $_GET variables.
+
+= 0.1 =
+First version.

kb-debug/trunk/kb_debug.php

@@ -233 +233 @@
         new KB_Debug_Hooks();
 }
+
+
+/* 2. Reset capabilities to initial state if KB_RESET_CAPS is set in $_GET */
+
+/**
+ * Reverts capabilities to default state. 
+ *
+ * Useful while debugging.
+ */
+function kb_reset_caps() {
+    global $wpdb;
+    $key = $wpdb->prefix . 'user_roles';
+
+    //Bye, bye, existing caps
+    delete_option( $key );
+
+    //Repopulate
+    require_once( "/home/kunalb/dev/eventpress/wp-admin/includes/schema.php" );
+    populate_roles();
+}
+if (isset( $_GET['KB_RESET_CAPS'] ))
+    add_action( 'init', kb_reset_caps );