Function Hook_block_ui_renderers_news->render_block_ui_parameter_hidden
Definitions
sources/hooks/systems/block_ui_renderers/news.php
- See if a particular block parameter's UI input can be handled as a hidden field.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: object
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $block | ID_TEXT | No | No | required parameter | N/A | N/A | The block |
| $parameter | ID_TEXT | No | No | required parameter | N/A | N/A | The parameter of the block |
| $has_default | boolean | No | No | required parameter | N/A | N/A | Whether there is a default value for the field, due to this being an edit |
| $default | string | No | No | required parameter | N/A | N/A | Default value for field |
Returns
- Rendered field (null: not handled)
- Type: ?Tempcode
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* See if a particular block parameter's UI input can be handled as a hidden field.
*
* @param ID_TEXT $block The block
* @param ID_TEXT $parameter The parameter of the block
* @param boolean $has_default Whether there is a default value for the field, due to this being an edit
* @param string $default Default value for field
* @return ?Tempcode Rendered field (null: not handled)
*/
public function render_block_ui_parameter_hidden(string $block, string $parameter, bool $has_default, string $default) : ?object
* See if a particular block parameter's UI input can be handled as a hidden field.
*
* @param ID_TEXT $block The block
* @param ID_TEXT $parameter The parameter of the block
* @param boolean $has_default Whether there is a default value for the field, due to this being an edit
* @param string $default Default value for field
* @return ?Tempcode Rendered field (null: not handled)
*/
public function render_block_ui_parameter_hidden(string $block, string $parameter, bool $has_default, string $default) : ?object
