Function __global->confirm_screen

Definitions

sources/templates_confirm_screen.php

  • Get the Tempcode for a confirmation page.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: object

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$title Tempcode No No required parameter N/A N/A The title for the confirmation page (out of get_screen_title)
$preview Tempcode No No required parameter N/A N/A The preview that's being confirmed for actualisation
$url_type mixed No No required parameter N/A N/A The URL type to confirm through to OR a full URL OR a full URL (if long, or if Tempcode)
$back_url_type ?mixed No No Null N/A N/A The URL type if we click back OR a full URL (if long, or if Tempcode) (null: none)
$sup_post array No No [] N/A N/A A map of supplementary post data to get passed through upon confirmation
$fields ?Tempcode No No Null N/A N/A Form fields to pass through as post data on confirmation (null: none)

Returns

  • The confirmation page
  • Type: Tempcode
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get the Tempcode for a confirmation page.
 *
 * @param  Tempcode $title The title for the confirmation page (out of get_screen_title)
 * @param  Tempcode $preview The preview that's being confirmed for actualisation
 * @param  mixed $url_type The URL type to confirm through to OR a full URL OR a full URL (if long, or if Tempcode)
 * @param  ?mixed $back_url_type The URL type if we click back OR a full URL (if long, or if Tempcode) (null: none)
 * @param  array $sup_post A map of supplementary post data to get passed through upon confirmation
 * @param  ?Tempcode $fields Form fields to pass through as post data on confirmation (null: none)
 * @return Tempcode The confirmation page
 */
function confirm_screen(object $title, object $preview, $url_type, $back_url_type = null, array $sup_post = [], ?object $fields = null) : object