Changeset 47122 for trunk/src/wp-includes/default-constants.php

Timestamp:

01/29/2020 12:43:23 AM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve inline comments per the documentation standards.

Includes minor code layout fixes for better readability.

See #48303.

File:

• trunk/src/wp-includes/default-constants.php (modified) (17 diffs)

trunk/src/wp-includes/default-constants.php

@@ -7 +7 @@
 
 /**
- * Defines initial WordPress constants
+ * Defines initial WordPress constants.
  *
  * @see wp_debug_mode()
@@ -70 +70 @@
 
     if ( ! defined( 'WP_CONTENT_DIR' ) ) {
-        define( 'WP_CONTENT_DIR', ABSPATH . 'wp-content' ); // no trailing slash, full paths only - WP_CONTENT_URL is defined further down
+        define( 'WP_CONTENT_DIR', ABSPATH . 'wp-content' ); // No trailing slash, full paths only - WP_CONTENT_URL is defined further down.
     }
 
@@ -78 +78 @@
     }
 
-    // Add define( 'WP_DEBUG_DISPLAY', null ); to wp-config.php use the globally configured setting for
-    // display_errors and not force errors to be displayed. Use false to force display_errors off.
+    // Add define( 'WP_DEBUG_DISPLAY', null ); to wp-config.php use the globally configured setting
+    // for 'display_errors' and not force errors to be displayed. Use false to force 'display_errors' off.
     if ( ! defined( 'WP_DEBUG_DISPLAY' ) ) {
         define( 'WP_DEBUG_DISPLAY', true );
@@ -116 +116 @@
     }
 
-    // Constants for features added to WP that should short-circuit their plugin implementations
+    // Constants for features added to WP that should short-circuit their plugin implementations.
     define( 'WP_FEATURE_BETTER_PASSWORDS', true );
 
@@ -142 +142 @@
 
 /**
- * Defines plugin directory WordPress constants
- *
- * Defines must-use plugin directory constants, which may be overridden in the sunrise.php drop-in
+ * Defines plugin directory WordPress constants.
+ *
+ * Defines must-use plugin directory constants, which may be overridden in the sunrise.php drop-in.
  *
  * @since 3.0.0
@@ -150 +150 @@
 function wp_plugin_directory_constants() {
     if ( ! defined( 'WP_CONTENT_URL' ) ) {
-        define( 'WP_CONTENT_URL', get_option( 'siteurl' ) . '/wp-content' ); // full url - WP_CONTENT_DIR is defined further up
+        define( 'WP_CONTENT_URL', get_option( 'siteurl' ) . '/wp-content' ); // Full URL - WP_CONTENT_DIR is defined further up.
     }
 
@@ -159 +159 @@
      */
     if ( ! defined( 'WP_PLUGIN_DIR' ) ) {
-        define( 'WP_PLUGIN_DIR', WP_CONTENT_DIR . '/plugins' ); // full path, no trailing slash
+        define( 'WP_PLUGIN_DIR', WP_CONTENT_DIR . '/plugins' ); // Full path, no trailing slash.
     }
 
@@ -168 +168 @@
      */
     if ( ! defined( 'WP_PLUGIN_URL' ) ) {
-        define( 'WP_PLUGIN_URL', WP_CONTENT_URL . '/plugins' ); // full url, no trailing slash
+        define( 'WP_PLUGIN_URL', WP_CONTENT_URL . '/plugins' ); // Full URL, no trailing slash.
     }
 
@@ -187 +187 @@
      */
     if ( ! defined( 'WPMU_PLUGIN_DIR' ) ) {
-        define( 'WPMU_PLUGIN_DIR', WP_CONTENT_DIR . '/mu-plugins' ); // full path, no trailing slash
+        define( 'WPMU_PLUGIN_DIR', WP_CONTENT_DIR . '/mu-plugins' ); // Full path, no trailing slash.
     }
 
@@ -196 +196 @@
      */
     if ( ! defined( 'WPMU_PLUGIN_URL' ) ) {
-        define( 'WPMU_PLUGIN_URL', WP_CONTENT_URL . '/mu-plugins' ); // full url, no trailing slash
+        define( 'WPMU_PLUGIN_URL', WP_CONTENT_URL . '/mu-plugins' ); // Full URL, no trailing slash.
     }
 
@@ -211 +211 @@
 
 /**
- * Defines cookie related WordPress constants
+ * Defines cookie-related WordPress constants.
  *
  * Defines constants after multisite is loaded.
@@ -219 +219 @@
 function wp_cookie_constants() {
     /**
-     * Used to guarantee unique hash cookies
+     * Used to guarantee unique hash cookies.
      *
      * @since 1.5.0
@@ -345 +345 @@
 
 /**
- * Defines functionality related WordPress constants
+ * Defines functionality-related WordPress constants.
  *
  * @since 3.0.0
@@ -354 +354 @@
      */
     if ( ! defined( 'AUTOSAVE_INTERVAL' ) ) {
-        define( 'AUTOSAVE_INTERVAL', 60 );
+        define( 'AUTOSAVE_INTERVAL', MINUTE_IN_SECONDS );
     }
 
@@ -372 +372 @@
      */
     if ( ! defined( 'WP_CRON_LOCK_TIMEOUT' ) ) {
-        define( 'WP_CRON_LOCK_TIMEOUT', 60 );  // In seconds
-    }
-}
-
-/**
- * Defines templating related WordPress constants
+        define( 'WP_CRON_LOCK_TIMEOUT', MINUTE_IN_SECONDS );
+    }
+}
+
+/**
+ * Defines templating-related WordPress constants.
  *
  * @since 3.0.0
@@ -383 +383 @@
 function wp_templating_constants() {
     /**
-     * Filesystem path to the current active template directory
+     * Filesystem path to the current active template directory.
      *
      * @since 1.5.0
@@ -390 +390 @@
 
     /**
-     * Filesystem path to the current active template stylesheet directory
+     * Filesystem path to the current active template stylesheet directory.
      *
      * @since 2.1.0