Function __global->_check_block_installation_status
Definitions
sources/zones.php
- Check a block is properly installed/upgraded, and give an error message if it is not.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: object
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $object | object | No | No | required parameter | N/A | N/A | The block object |
| $codename | ID_TEXT | No | No | required parameter | N/A | N/A | The block name |
Returns
- The block error output (null: no error)
- Type: ?Tempcode
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Check a block is properly installed/upgraded, and give an error message if it is not.
*
* @param object $object The block object
* @param ID_TEXT $codename The block name
* @return ?Tempcode The block error output (null: no error)
*/
function _check_block_installation_status(object $object, string $codename) : ?object
* Check a block is properly installed/upgraded, and give an error message if it is not.
*
* @param object $object The block object
* @param ID_TEXT $codename The block name
* @return ?Tempcode The block error output (null: no error)
*/
function _check_block_installation_status(object $object, string $codename) : ?object
