Function Hook_cns_warnings_syndicate->get_stepper

Definitions

sources/hooks/systems/cns_warnings/syndicate.php

  • Return information for the standing profile tab.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: array

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$member_id_of MEMBER No No required parameter N/A N/A The member whose profile we are viewing
$member_id_viewing MEMBER No No required parameter N/A N/A The member who is viewing the profile
$warning_ids array No No required parameter N/A N/A Array of formal warning IDs against this member for checking against queried punitive actions

Returns

  • Array of maps with information about this punitive action
  • Type: array
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Return information for the standing profile tab.
 *
 * @param  MEMBER $member_id_of The member whose profile we are viewing
 * @param  MEMBER $member_id_viewing The member who is viewing the profile
 * @param  array $warning_ids Array of formal warning IDs against this member for checking against queried punitive actions
 * @return array Array of maps with information about this punitive action
 */
public function get_stepper(int $member_id_of, int $member_id_viewing, array $warning_ids) : array