Function __global->build_preview

Definitions

sources/preview.php

  • Build up a preview based on what was submitted.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$multi_return boolean No No False N/A N/A Whether to return additional data

Returns

  • Either Tempcode for the preview, or a tuple of details
  • Type: mixed
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Build up a preview based on what was submitted.
 *
 * @param  boolean $multi_return Whether to return additional data
 * @return mixed Either Tempcode for the preview, or a tuple of details
 */
function build_preview(bool $multi_return = false)