Changeset 27375 for trunk/src/wp-admin/includes/misc.php

Timestamp:

03/03/2014 05:19:31 PM (11 years ago)

Author:

DrewAPicture

Message:

Inline documentation for hooks in wp-admin/includes/misc.php.

Props JoshuaAbenazer.
Fixes #26186

File:

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

trunk/src/wp-admin/includes/misc.php

@@ -28 +28 @@
      * @param bool $got_rewrite Whether Apache and mod_rewrite are present.
      */
-    return apply_filters('got_rewrite', $got_rewrite);
+    return apply_filters( 'got_rewrite', $got_rewrite );
 }
 
@@ -335 +335 @@
     $functions = array_unique( $functions );
     sort( $functions );
+
+    /**
+     * Filter the list of functions/classes to be ignored from the documentation lookup.
+     *
+     * @since 2.8.0
+     *
+     * @param array $ignore_functions Functions/Classes to be ignored.
+     */
     $ignore_functions = apply_filters( 'documentation_ignore_functions', $ignore_functions );
+
     $ignore_functions = array_unique( $ignore_functions );
 
@@ -352 +361 @@
  *
  * @since 2.8.0
-**/
+ */
 function set_screen_options() {
 
@@ -395 +404 @@
                 break;
             default:
-                $value = apply_filters('set-screen-option', false, $option, $value);
+
+                /**
+                 * Filter the default of number of rows value to use for item listings.
+                 *
+                 * @since 2.8.0
+                 *
+                 * @param bool|int $value  The number of rows value. Default false.
+                 * @param string   $option The option name.
+                 * @param int      $value  The number of rows to use.
+                 */
+                $value = apply_filters( 'set-screen-option', false, $option, $value );
+
                 if ( false === $value )
                     return;