Ticket #25229: wp-admin-includes-plugin-install.25229.2.diff

wp-admin/includes/plugin-install.php

@@ -34 +34 @@
         if ( !isset($args->per_page) )
                 $args->per_page = 24;
 
-        // Allows a plugin to override the WordPress.org API entirely.
-        // Use the filter 'plugins_api_result' to merely add results.
-        // Please ensure that a object is returned from the following filters.
-        $args = apply_filters('plugins_api_args', $args, $action);
-        $res = apply_filters('plugins_api', false, $action, $args);
+        /**
+         * Override the Plugin API arguments.
+         *
+         * Please ensure that an object is returned.
+         *
+         * @since 2.7.0
+         *
+         * @param object $args   Plugin API arguments.
+         * @param string $action The type of information being requested from the Plugin API.
+         */
+        $args = apply_filters( 'plugins_api_args', $args, $action );
+
+        /**
+         * Allows a plugin to override the WordPress.org API entirely.
+         *
+         * Please ensure that an object is returned.
+         *
+         * @since 2.7.0
+         *
+         * @param bool|object         The result object. Default is false.
+         * @param string      $action The type of information being requested from the Plugin API.
+         * @param object      $args   Plugin API arguments.
+         */
+        $res = apply_filters( 'plugins_api', false, $action, $args );
 
         if ( false === $res ) {
                 $url = 'http://api.wordpress.org/plugins/info/1.0/';
@@ -64 +83 @@
                 $res->external = true;
         }
 
-        return apply_filters('plugins_api_result', $res, $action, $args);
+        /**
+         * Add a result to the Plugin API response.
+         *
+         * @since 2.7.0
+         *
+         * @param object $res    Response object or WP_Error.
+         * @param string $action The type of information being requested from the Plugin API.
+         * @param object $args   Plugin API arguments.
+         */
+        return apply_filters( 'plugins_api_result', $res, $action, $args );
 }
 
 /**