Changeset 33226 for trunk/src/wp-includes/functions.php

Timestamp:

07/13/2015 09:34:35 PM (10 years ago)

Author:

DrewAPicture

Message:

Fix inline documentation syntax for a few general-purpose functions and hooks added in 4.3.

• _deprecated_constructor() See [32989]
• deprecated_constructor_trigger_error See [32989]
• get_main_network_id() See [32775]
• wp_post_preview_js() See [32809]

See #32891.

File:

• trunk/src/wp-includes/functions.php (modified) (4 diffs)

trunk/src/wp-includes/functions.php

@@ -3422 +3422 @@
  * remove PHP4 style constructors.
  *
- * The current behavior is to trigger a user error if WP_DEBUG is true.
+ * The current behavior is to trigger a user error if `WP_DEBUG` is true.
  *
  * This function is to be used in every PHP4 style constructor method that is deprecated.
  *
  * @since 4.3.0
- *
  * @access private
  *
@@ -3447 +3446 @@
     /**
      * Filter whether to trigger an error for deprecated functions.
+     *
+     * `WP_DEBUG` must be true in addition to the filter evaluating to true.
      *
      * @since 4.3.0
@@ -3944 +3945 @@
  * @since 4.3.0
  *
- * @global wpdb $wpdb
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @return int The ID of the main network.
@@ -4964 +4965 @@
 /**
  * Outputs a small JS snippet on preview tabs/windows to remove `window.name` on unload.
+ *
  * This prevents reusing the same tab for a preview when the user has navigated away.
  *