Function Hook_actionlog_core->get_written_context

Definitions

sources/hooks/systems/actionlog/core.php

  • Get written context for an action log entry handled by this hook.
  • Visibility: protected
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: string

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$actionlog_row array No No required parameter N/A N/A Action log row
$handler_data array No No required parameter N/A N/A Handler data
$identifier ?string No No required parameter N/A N/A Identifier (null: none)

Returns

  • Written context (null: none)
  • Type: ?string
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get written context for an action log entry handled by this hook.
 *
 * @param  array $actionlog_row Action log row
 * @param  array $handler_data Handler data
 * @param  ?string $identifier Identifier (null: none)
 * @return ?string Written context (null: none)
 */
protected function get_written_context(array $actionlog_row, array $handler_data, ?string $identifier) : ?string