Function __global->get_block_info_row

Definitions

sources/zones.php

  • Get standardised info about a block.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: array

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$codename ID_TEXT No No required parameter N/A N/A The block name
$map array No No [] N/A N/A The block parameter map
&$object ?mixed Yes No Null N/A N/A Object/string of the block (null: not looked up)
&$new_security_scope ?boolean Yes No Null N/A N/A Whether the block is in a new security scope (null: not looked up)

Returns

  • The block info (null: cannot cache for some reason)
  • Type: ?array
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get standardised info about a block.
 *
 * @param  ID_TEXT $codename The block name
 * @param  array $map The block parameter map
 * @param  ?mixed $object Object/string of the block (null: not looked up)
 * @param  ?boolean $new_security_scope Whether the block is in a new security scope (null: not looked up)
 * @return ?array The block info (null: cannot cache for some reason)
 */
function get_block_info_row(string $codename, array $map = [], &$object = null, ?bool &$new_security_scope = null) : ?array