Function __global->inform_about_addon_install

Definitions

sources/addons2.php

  • Get information for the user relating to an addon that they are intending to install.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: array

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$file string No No required parameter N/A N/A Filename of the addon TAR file
$also_uninstalling array No No [] N/A N/A List of addons that we're currently uninstalling (so dependencies from these are irrelevant)
$also_installing array No No [] N/A N/A List of addons that we're currently installing (so dependencies to these are irrelevant)
$always_return boolean No No False N/A N/A Whether to make sure we always return, rather than possibly bombing out with a dependency management UI

Returns

  • Triple: warnings, files, addon info array
  • Type: array
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get information for the user relating to an addon that they are intending to install.
 *
 * @param  string $file Filename of the addon TAR file
 * @param  array $also_uninstalling List of addons that we're currently uninstalling (so dependencies from these are irrelevant)
 * @param  array $also_installing List of addons that we're currently installing (so dependencies to these are irrelevant)
 * @param  boolean $always_return Whether to make sure we always return, rather than possibly bombing out with a dependency management UI
 * @return array Triple: warnings, files, addon info array
 */
function inform_about_addon_install(string $file, array $also_uninstalling = [], array $also_installing = [], bool $always_return = false) : array