<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" /><style type="text/css"><!--
#msg dl { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fc0 solid; padding: 6px; }
#msg ul, pre { overflow: auto; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<title>[13176] trunk/wp-includes: Better inline documentation for WP_DEBUG,
WP_DEBUG_DISPLAY, and WP_DEBUG_LOG.</title>
</head>
<body>
<div id="msg">
<dl>
<dt>Revision</dt> <dd><a href="http://trac.wordpress.org/changeset/13176">13176</a></dd>
<dt>Author</dt> <dd>nacin</dd>
<dt>Date</dt> <dd>2010-02-17 13:14:45 +0000 (Wed, 17 Feb 2010)</dd>
</dl>
<h3>Log Message</h3>
<pre>Better inline documentation for WP_DEBUG, WP_DEBUG_DISPLAY, and WP_DEBUG_LOG. Fixes <a href="http://trac.wordpress.org/ticket/11987">#11987</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkwpincludesdefaultconstantsphp">trunk/wp-includes/default-constants.php</a></li>
<li><a href="#trunkwpincludesloadphp">trunk/wp-includes/load.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkwpincludesdefaultconstantsphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-includes/default-constants.php (13175 => 13176)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-includes/default-constants.php 2010-02-17 12:26:47 UTC (rev 13175)
+++ trunk/wp-includes/default-constants.php 2010-02-17 13:14:45 UTC (rev 13176)
</span><span class="lines">@@ -7,7 +7,9 @@
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="cx"> * Defines initial WordPress constants
</span><del>- *
</del><ins>+ *
+ * @see wp_debug_mode()
+ *
</ins><span class="cx"> * @since 3.0.0
</span><span class="cx"> */
</span><span class="cx"> function wp_initial_constants( ) {
</span><span class="lines">@@ -43,11 +45,11 @@
</span><span class="cx"> if ( !defined('WP_DEBUG') )
</span><span class="cx"> define( 'WP_DEBUG', false );
</span><span class="cx">
</span><del>- // 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
</del><ins>+ // 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.
</ins><span class="cx"> if ( !defined('WP_DEBUG_DISPLAY') )
</span><span class="cx"> define( 'WP_DEBUG_DISPLAY', true );
</span><span class="cx">
</span><del>- // Add define('WP_DEBUG_LOG', true); to enable php debug logging to WP_CONTENT_DIR/debug.log
</del><ins>+ // Add define('WP_DEBUG_LOG', true); to enable error logging to wp-content/debug.log.
</ins><span class="cx"> if ( !defined('WP_DEBUG_LOG') )
</span><span class="cx"> define('WP_DEBUG_LOG', false);
</span><span class="cx">
</span></span></pre></div>
<a id="trunkwpincludesloadphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-includes/load.php (13175 => 13176)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-includes/load.php 2010-02-17 12:26:47 UTC (rev 13175)
+++ trunk/wp-includes/load.php 2010-02-17 13:14:45 UTC (rev 13176)
</span><span class="lines">@@ -208,17 +208,29 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Sets PHP error handling.
</del><ins>+ * Sets PHP error handling and handles WordPress debug mode.
</ins><span class="cx"> *
</span><del>- * Add <code>define('WP_DEBUG', true);</code> to wp-config.php to enable
- * the reporting of notices during development.
</del><ins>+ * 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>
</ins><span class="cx"> *
</span><del>- * Add <code>define('WP_DEBUG_DISPLAY', false);</code> to wp-config.php to
- * disable the display of errors.
</del><ins>+ * WP_DEBUG_DISPLAY and WP_DEBUG_LOG perform no function unless WP_DEBUG is true.
+ * WP_DEBUG defaults defaults to false.
</ins><span class="cx"> *
</span><del>- * Add <code>define('WP_DEBUG_LOG', true);</code> to wp-config.php to log
- * eerrors to debug.log in the wp-content directory.
</del><ins>+ * 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.
</ins><span class="cx"> *
</span><ins>+ * 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.
+ *
</ins><span class="cx"> * @access private
</span><span class="cx"> * @since 3.0.0
</span><span class="cx"> */
</span></span></pre>
</div>
</div>
</body>
</html>