Function __global->get_recursive_gallery_details

Definitions

sources/galleries.php

  • Get details of the contents of a gallery.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: array

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$name ID_TEXT No No required parameter N/A N/A The name of the gallery
$test_videos boolean No No True N/A N/A Whether to test for videos when making counts (ignore this parameter - used internally)
$test_images boolean No No True N/A N/A Whether to test for images when making counts (ignore this parameter - used internally)

Returns

  • A triplet: (num children, num images, num videos)
  • Type: array
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get details of the contents of a gallery.
 *
 * @param  ID_TEXT $name The name of the gallery
 * @param  boolean $test_videos Whether to test for videos when making counts (ignore this parameter - used internally)
 * @param  boolean $test_images Whether to test for images when making counts (ignore this parameter - used internally)
 * @return array A triplet: (num children, num images, num videos)
 */
function get_recursive_gallery_details(string $name, bool $test_videos = true, bool $test_images = true) : array