Function __global->read_addon_info

Definitions

sources/addons.php

  • Get info about an addon, simulating an extended version of the traditional addon database row.
  • 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 The name of the addon
$get_dependencies_on_this boolean No No False N/A N/A Whether to search for dependencies on this
$row ?array No No Null N/A N/A Database row (null: lookup via a new query)
$ini_info ?array No No Null N/A N/A .ini-format info (needs processing) (null: unknown / N/A)
$path ?PATH No No Null N/A N/A Force reading from a particular path (null: no path)

Returns

  • The map of details
  • Type: array
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get info about an addon, simulating an extended version of the traditional addon database row.
 *
 * @param  string $addon_name The name of the addon
 * @param  boolean $get_dependencies_on_this Whether to search for dependencies on this
 * @param  ?array $row Database row (null: lookup via a new query)
 * @param  ?array $ini_info .ini-format info (needs processing) (null: unknown / N/A)
 * @param  ?PATH $path Force reading from a particular path (null: no path)
 * @return array The map of details
 */
function read_addon_info(string $addon_name, bool $get_dependencies_on_this = false, ?array $row = null, ?array $ini_info = null, ?string $path = null) : array