Function __global->put_in_standard_box

Definitions

sources/templates.php

  • Get the Tempcode for a standard box (CSS driven), with the specified content entered. Please rarely use this function; it is not good to assume people want anythings in one of these boxes... use templates instead.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: object

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$content Tempcode No No required parameter N/A N/A The content being put inside the box, provided in HTML format
$title ?Tempcode No No Null N/A N/A The title of the standard box, provided in HTML format (null: titleless standard box) (blank: titleless standard box)
$type ID_TEXT No No default N/A N/A The type of the box. Refers to a template (STANDARDBOX_type)
$width string No No Blank (empty string) N/A N/A The CSS width
$options string No No Blank (empty string) N/A N/A '|' separated list of options (meaning dependant upon templates interpretation)
$meta string No No Blank (empty string) N/A N/A '|' separated list of meta information (key|value|key|value|...)
$links string No No Blank (empty string) N/A N/A '|' separated list of link information (linkhtml|...)
$top_links string No No Blank (empty string) N/A N/A Link to be added to the header of the box
$class string No No Blank (empty string) N/A N/A CSS class to use

Returns

  • The contents, put inside a standard box, according to the other parameters
  • Type: Tempcode
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get the Tempcode for a standard box (CSS driven), with the specified content entered. Please rarely use this function; it is not good to assume people want anythings in one of these boxes... use templates instead.
 *
 * @param  Tempcode $content The content being put inside the box, provided in HTML format
 * @param  ?Tempcode $title The title of the standard box, provided in HTML format (null: titleless standard box) (blank: titleless standard box)
 * @param  ID_TEXT $type The type of the box. Refers to a template (STANDARDBOX_type)
 * @param  string $width The CSS width
 * @param  string $options '|' separated list of options (meaning dependant upon templates interpretation)
 * @param  string $meta '|' separated list of meta information (key|value|key|value|...)
 * @param  string $links '|' separated list of link information (linkhtml|...)
 * @param  string $top_links Link to be added to the header of the box
 * @param  string $class CSS class to use
 * @return Tempcode The contents, put inside a standard box, according to the other parameters
 */
function put_in_standard_box(object $content, ?object $title = null, string $type = 'default', string $width = '', string $options = '', string $meta = '', string $links = '', string $top_links = '', string $class = '') : object