sergiotarxz
/
Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

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
This commit is contained in:
Pascal Birchler 2016-10-17 08:29:30 +00:00
parent b9894d3295
commit 9639758d1c
1 changed files with 10 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
src/wp-admin/includes/plugin-install.php
View File

@ -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.