Function __global->inform_about_addon_uninstall

Definitions

sources/addons2.php

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

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$addon_name string No No required parameter N/A N/A Name of the addon
$also_uninstalling array No No [] N/A N/A List of addons that we're currently uninstalling (so dependencies from these are irrelevant)
$addon_info ?array No No Null N/A N/A Addon details. (null: load in function)
$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

  • Pair: warnings, files
  • 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 uninstall.
 *
 * @param  string $addon_name Name of the addon
 * @param  array $also_uninstalling List of addons that we're currently uninstalling (so dependencies from these are irrelevant)
 * @param  ?array $addon_info Addon details. (null: load in function)
 * @param  boolean $always_return Whether to make sure we always return, rather than possibly bombing out with a dependency management UI
 * @return array Pair: warnings, files
 */
function inform_about_addon_uninstall(string $addon_name, array $also_uninstalling = [], ?array $addon_info = null, bool $always_return = false) : array