From 9639758d1ccc762c4b0cd58037331124eb3b6b0c Mon Sep 17 00:00:00 2001 From: Pascal Birchler Date: Mon, 17 Oct 2016 08:29:30 +0000 Subject: [PATCH] Docs: Improve documentation for `install_plugin_install_status()`. Props clarionwpdeveloper, sudar. Fixes #36912. git-svn-id: https://develop.svn.wordpress.org/trunk@38805 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-admin/includes/plugin-install.php | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/src/wp-admin/includes/plugin-install.php b/src/wp-admin/includes/plugin-install.php index 5b29fd9e0b..0660644736 100644 --- a/src/wp-admin/includes/plugin-install.php +++ b/src/wp-admin/includes/plugin-install.php @@ -348,9 +348,16 @@ function display_plugins_table() { * * @since 3.0.0 * - * @param array|object $api - * @param bool $loop - * @return type + * @param array|object $api Data about the plugin retrieved from the API. + * @param bool $loop Optional. Disable further loops. Default false. + * @return array { + * Plugin installation status data. + * + * @type string $status Status of a plugin. Could be one of 'install', 'update_available', 'latest_installed' or 'newer_installed'. + * @type string $url Plugin installation URL. + * @type string $version The most recent version of the plugin. + * @type string $file Plugin filename relative to the plugins directory. + * } */ function install_plugin_install_status($api, $loop = false) { // This function is called recursively, $loop prevents further loops.