apply_filters( 'plugin_install_description', string $description, array $plugin )

Filters the plugin card description on the Add Plugins screen.


Parameters

$description string
Plugin card description.
$plugin array
An array of plugin data. See plugins_api() for the list of possible values.
More Arguments from plugins_api( ... $args ) Array or object of arguments to serialize for the Plugin Info API.
  • slugstring
    The plugin slug.
  • per_pageint
    Number of plugins per page. Default 24.
  • pageint
    Number of current page. Default 1.
  • numberint
    Number of tags or categories to be queried.
  • searchstring
    A search term.
  • tagstring
    Tag to filter plugins.
  • authorstring
    Username of an plugin author to filter plugins.
  • userstring
    Username to query for their favorites.
  • browsestring
    Browse view: 'popular', 'new', 'beta', 'recommended'.
  • localestring
    Locale to provide context-sensitive results. Default is the value of get_locale() .
  • installed_pluginsstring
    Installed plugins to provide context-sensitive results.
  • is_sslbool
    Whether links should be returned with https or not. Default false.
  • fieldsarray
    Array of fields which should or should not be returned.
    • short_descriptionbool
      Whether to return the plugin short description. Default true.
    • descriptionbool
      Whether to return the plugin full description. Default false.
    • sectionsbool
      Whether to return the plugin readme sections: description, installation, FAQ, screenshots, other notes, and changelog. Default false.
    • testedbool
      Whether to return the 'Compatible up to' value. Default true.
    • requiresbool
      Whether to return the required WordPress version. Default true.
    • requires_phpbool
      Whether to return the required PHP version. Default true.
    • ratingbool
      Whether to return the rating in percent and total number of ratings.
      Default true.
    • ratingsbool
      Whether to return the number of rating for each star (1-5). Default true.
    • downloadedbool
      Whether to return the download count. Default true.
    • downloadlinkbool
      Whether to return the download link for the package. Default true.
    • last_updatedbool
      Whether to return the date of the last update. Default true.
    • addedbool
      Whether to return the date when the plugin was added to the wordpress.org repository. Default true.
    • tagsbool
      Whether to return the assigned tags. Default true.
    • compatibilitybool
      Whether to return the WordPress compatibility list. Default true.
    • homepagebool
      Whether to return the plugin homepage link. Default true.
    • versionsbool
      Whether to return the list of all available versions. Default false.
    • donate_linkbool
      Whether to return the donation link. Default true.
    • reviewsbool
      Whether to return the plugin reviews. Default false.
    • bannersbool
      Whether to return the banner images links. Default false.
    • iconsbool
      Whether to return the icon links. Default false.
    • active_installsbool
      Whether to return the number of active installations. Default false.
    • groupbool
      Whether to return the assigned group. Default false.
    • contributorsbool
      Whether to return the list of contributors. Default false.

Top ↑

Source

File: wp-admin/includes/class-wp-plugin-install-list-table.php. View all references

$description = apply_filters( 'plugin_install_description', $description, $plugin );


Top ↑

Changelog

Changelog
Version Description
6.0.0 Introduced.

Top ↑

User Contributed Notes

You must log in before being able to contribute a note or feedback.