Function Hook_commandr_fs_forum_groupings->file_load

Definitions

sources/hooks/systems/commandr_fs/forum_groupings.php

  • Standard Commandr-fs load function for resource-fs hooks. Finds the properties for some resource.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$filename SHORT_TEXT No No required parameter N/A N/A Filename
$path string No No required parameter N/A N/A The path (blank: root / not applicable). It may be a wildcarded path, as the path is used for content-type identification only. Filenames are globally unique across a hook; you can calculate the path using ->search.

Returns

  • Details of the resource (false: error)
  • Type: ~array
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Standard Commandr-fs load function for resource-fs hooks. Finds the properties for some resource.
 *
 * @param  SHORT_TEXT $filename Filename
 * @param  string $path The path (blank: root / not applicable). It may be a wildcarded path, as the path is used for content-type identification only. Filenames are globally unique across a hook; you can calculate the path using ->search.
 * @return ~array Details of the resource (false: error)
 */
public function file_load(string $filename, string $path)