Docs: Improve documentation for `install_plugin_install_status()`.

Props clarionwpdeveloper, sudar.
Fixes #36912.
Built from https://develop.svn.wordpress.org/trunk@38805


git-svn-id: http://core.svn.wordpress.org/trunk@38748 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Pascal Birchler 2016-10-17 08:30:29 +00:00
parent ffdef38f5b
commit 1e54943b0f
2 changed files with 11 additions and 4 deletions

View File

@ -348,9 +348,16 @@ function display_plugins_table() {
* *
* @since 3.0.0 * @since 3.0.0
* *
* @param array|object $api * @param array|object $api Data about the plugin retrieved from the API.
* @param bool $loop * @param bool $loop Optional. Disable further loops. Default false.
* @return type * @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) { function install_plugin_install_status($api, $loop = false) {
// This function is called recursively, $loop prevents further loops. // This function is called recursively, $loop prevents further loops.

View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.7-alpha-38804'; $wp_version = '4.7-alpha-38805';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.