Changeset 38121 for trunk/src/wp-includes/compat.php

Timestamp:

07/20/2016 04:56:21 PM (8 years ago)

Author:

DrewAPicture

Message:

Docs: Fix formatting, tense, verb conjugation, and other syntax for wp-includes/* elements introduced or changed in 4.6.

Part 1/2.

See #37318.

File:

• trunk/src/wp-includes/compat.php (modified) (3 diffs)

trunk/src/wp-includes/compat.php

@@ -518 +518 @@
 
     /**
-     * Register a function to be autoloaded.
+     * Registers a function to be autoloaded.
      *
      * @since 4.6.0
      *
      * @param callable $autoload_function The function to register.
-     * @param boolean $throw Should the function throw an exception if the function isn't callable?
-     * @param boolean $prepend Should we prepend the function to the stack?
+     * @param bool     $throw             Optional. Whether the function should throw an exception
+     *                                    if the function isn't callable. Default true.
+     * @param bool     $prepend           Whether the function should be prepended to the stack.
+     *                                    Default false.
      */
     function spl_autoload_register( $autoload_function, $throw = true, $prepend = false ) {
@@ -547 +549 @@
 
     /**
-     * Unregister an autoloader function.
+     * Unregisters an autoloader function.
      *
      * @since 4.6.0
      *
      * @param callable $function The function to unregister.
-     * @return boolean True if the function was unregistered, false if it could not be.
+     * @return bool True if the function was unregistered, false if it could not be.
      */
     function spl_autoload_unregister( $function ) {
@@ -567 +569 @@
 
     /**
-     * Get the registered autoloader functions.
+     * Retrieves the registered autoloader functions.
      *
      * @since 4.6.0