WordPress.org

Make WordPress Core

Changeset 34631


Ignore:
Timestamp:
09/27/2015 06:12:59 PM (4 years ago)
Author:
DrewAPicture
Message:

Docs: Add documentation for the $browse, $user, $search, $author, $tag, $installed_plugins, and $page parameters in plugins_api().

Props ocean90.
Fixes #34035.

File:
1 edited

Legend:

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

    r34596 r34631  
    2828 *     Optional. Array or object of arguments to serialize for the Plugin Info API.
    2929 *
    30  *     @type string  $slug     The plugin slug.
    31  *     @type int     $per_page Number of plugins per page. Default 24.
    32  *     @type int     $number   Number of tags or categories to be queried.
    33  *     @type string  $locale   Locale to provide context-sensitive results. Default is the value of get_locale().
    34  *     @type bool    $is_ssl   Whether links should be returned with https or not. Default false.
    35  *     @type array   $fields   {
     30 *     @type string  $slug              The plugin slug. Default empty.
     31 *     @type int     $per_page          Number of plugins per page. Default 24.
     32 *     @type int     $page              Number of current page. Default 1.
     33 *     @type int     $number            Number of tags or categories to be queried.
     34 *     @type string  $search            A search term. Default empty.
     35 *     @type string  $tag               Tag to filter plugins. Default empty.
     36 *     @type string  $author            Username of an plugin author to filter plugins. Default empty.
     37 *     @type string  $user              Username to query for their favorites. Default empty.
     38 *     @type string  $browse            Browse view: 'popular', 'new', 'beta', 'recommended'.
     39 *     @type string  $locale            Locale to provide context-sensitive results. Default is the value
     40 *                                      of get_locale().
     41 *     @type string  $installed_plugins Installed plugins to provide context-sensitive results.
     42 *     @type bool    $is_ssl            Whether links should be returned with https or not. Default false.
     43 *     @type array   $fields            {
    3644 *         Array of fields which should or should not be returned.
    3745 *
Note: See TracChangeset for help on using the changeset viewer.