Ticket #25732: theme_doc.diff

src/wp-admin/includes/theme.php

@@ -277 +277 @@
 
         if ( !isset($args->per_page) )
                 $args->per_page = 24;
-
+        /**
+         * Ensure that an object is returned via this filter.
+         * 
+         * themes_api_args, is for the args in themes api and gives the action as
+         * the second parameter. The hook for 'themes_api_args' must ensure that an
+         * object is returned.
+         *
+         * @since 2.8.0
+         * 
+         * @param string $action
+         * @param array|object $args Optional. Arguments to serialize for the Theme Info API.
+         * @return object
+        */
         $args = apply_filters('themes_api_args', $args, $action); //NOTE: Ensure that an object is returned via this filter.
+        
+        /**
+         * Is the result that would be returned.
+         * 
+         * Allows a theme to completely override the builtin WordPress.org API.
+         * 
+         * @since 2.8.0
+         *
+         * @param boolean 
+         * @param string $action
+         * @param object $args
+         * 
+         */
         $res = apply_filters('themes_api', false, $action, $args); //NOTE: Allows a theme to completely override the builtin WordPress.org API.
 
         if ( ! $res ) {
@@ -302 +327 @@
                 }
         }
 
+        /**
+         * Return themes Features/params such as Colors, Columns, Features , Width,
+         * Subject... 
+         *
+         * @since 2.8.0
+         *
+         * @param mixed $res
+         * @param mixed $res
+         * @param object $args
+         */
         return apply_filters('themes_api_result', $res, $action, $args);
 }