Changeset 13176

Timestamp:

02/17/2010 01:14:45 PM (15 years ago)

Author:

nacin

Message:

Better inline documentation for WP_DEBUG, WP_DEBUG_DISPLAY, and WP_DEBUG_LOG. Fixes #11987

Location:

trunk/wp-includes

Files:

• default-constants.php (modified) (2 diffs)
• load.php (modified) (1 diff)

trunk/wp-includes/default-constants.php

@@ -8 +8 @@
 /**
  * Defines initial WordPress constants
- * 
+ *
+ * @see wp_debug_mode()
+ *
  * @since 3.0.0
  */
@@ -44 +46 @@
         define( 'WP_DEBUG', false );
 
-    // Add define('WP_DEBUG_DISPLAY', false); to wp-config.php to use the globally configured setting for display_errors and not force it to On
+    // Add define('WP_DEBUG_DISPLAY', false); to wp-config.php use the globally configured setting for display_errors and not force errors to be displayed.
     if ( !defined('WP_DEBUG_DISPLAY') )
         define( 'WP_DEBUG_DISPLAY', true );
 
-    // Add define('WP_DEBUG_LOG', true); to enable php debug logging to WP_CONTENT_DIR/debug.log
+    // Add define('WP_DEBUG_LOG', true); to enable error logging to wp-content/debug.log.
     if ( !defined('WP_DEBUG_LOG') )
         define('WP_DEBUG_LOG', false);

trunk/wp-includes/load.php

@@ -209 +209 @@
 
 /**
- * Sets PHP error handling.
- *
- * Add <code>define('WP_DEBUG', true);</code> to wp-config.php to enable
- * the reporting of notices during development.
- *
- * Add <code>define('WP_DEBUG_DISPLAY', false);</code> to wp-config.php to
- * disable the display of errors.
- *
- * Add <code>define('WP_DEBUG_LOG', true);</code> to wp-config.php to log
- * eerrors to debug.log in the wp-content directory.
+ * Sets PHP error handling and handles WordPress debug mode.
+ *
+ * Uses three constants: WP_DEBUG, WP_DEBUG_DISPLAY, and WP_DEBUG_LOG. All three can be
+ * defined in wp-config.php. Example: <code> define( 'WP_DEBUG', true ); </code>
+ *
+ * WP_DEBUG_DISPLAY and WP_DEBUG_LOG perform no function unless WP_DEBUG is true.
+ * WP_DEBUG defaults defaults to false.
+ *
+ * When WP_DEBUG is true, all PHP notices are reported. WordPress will also display
+ * notices, including one when a deprecated WordPress function, function argument,
+ * or file is used. Deprecated code may be removed from a later version.
+ *
+ * It is strongly recommended that plugin and theme authors use WP_DEBUG for their
+ * development environments.
+ *
+ * When WP_DEBUG_DISPLAY is true, WordPress will force errors to be displayed.
+ * WP_DEBUG_DISPLAY defaults to true. Defining it as false prevents WordPress from
+ * changing the global configuration setting. (Defining WP_DEBUG_DISPLAY as false
+ * will never force errors to be hidden.)
+ *
+ * When WP_DEBUG_LOG is true, errors will be logged to wp-content/debug.log.
+ * WP_DEBUG_LOG defaults to false.
  *
  * @access private