Function __global->get_web_notifications

Definitions

sources/notification_poller.php

  • Get web notification templating.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: array

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$max ?integer No No Null N/A N/A Number of notifications to show (null: no limit)
$start integer No No 0 N/A N/A Start offset
$skip_cache boolean No No False N/A N/A Whether to skip serving results from the cache

Returns

  • A tuple: Templating, Max rows, unread rows
  • Type: array
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get web notification templating.
 *
 * @param  ?integer $max Number of notifications to show (null: no limit)
 * @param  integer $start Start offset
 * @param  boolean $skip_cache Whether to skip serving results from the cache
 * @return array A tuple: Templating, Max rows, unread rows
 */

function get_web_notifications(?int $max = null, int $start = 0, bool $skip_cache = false) : array