WordPress.org

Make WordPress Core

Changeset 38805


Ignore:
Timestamp:
10/17/16 08:29:30 (10 months ago)
Author:
swissspidy
Message:

Docs: Improve documentation for install_plugin_install_status().

Props clarionwpdeveloper, sudar.
Fixes #36912.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-admin/includes/plugin-install.php

    r38795 r38805  
    349349 * @since 3.0.0 
    350350 * 
    351  * @param array|object $api 
    352  * @param bool        $loop 
    353  * @return type 
     351 * @param  array|object $api  Data about the plugin retrieved from the API. 
     352 * @param  bool         $loop Optional. Disable further loops. Default false. 
     353 * @return array { 
     354 *     Plugin installation status data. 
     355 * 
     356 *     @type string $status  Status of a plugin. Could be one of 'install', 'update_available', 'latest_installed' or 'newer_installed'. 
     357 *     @type string $url     Plugin installation URL. 
     358 *     @type string $version The most recent version of the plugin. 
     359 *     @type string $file    Plugin filename relative to the plugins directory. 
     360 * } 
    354361 */ 
    355362function install_plugin_install_status($api, $loop = false) { 
Note: See TracChangeset for help on using the changeset viewer.