Function __global->render_post_box
Definitions
sources/cns_posts2.php
- Show a post, isolated of the other posts in it's topic.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: object
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $row | array | No | No | required parameter | N/A | N/A | The post row |
| $use_post_title | boolean | No | No | False | N/A | N/A | Whether to include context (i.e. say WHAT this is, not just show the actual content). Also uses the post title, as opposed to the post's topic's title. |
| $give_context | boolean | No | No | True | N/A | N/A | Whether to embed a link to the topic |
| $include_breadcrumbs | boolean | No | No | True | N/A | N/A | Whether to include breadcrumbs (if there are any) |
| $root | ?AUTO_LINK | No | No | Null | N/A | N/A | Virtual root to use (null: none) |
| $guid | ID_TEXT | No | No | Blank (empty string) | N/A | N/A | Overridden GUID to send to templates (blank: none) |
| $text_summary | ?Tempcode | No | No | Null | N/A | N/A | Text summary for result (e.g. highlighted portion of actual file from search result) (null: none) |
| $zone | ID_TEXT | No | No | _SEARCH | N/A | N/A | The zone to display in |
Returns
- The isolated post
- Type: Tempcode
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Show a post, isolated of the other posts in it's topic.
*
* @param array $row The post row
* @param boolean $use_post_title Whether to include context (i.e. say WHAT this is, not just show the actual content). Also uses the post title, as opposed to the post's topic's title.
* @param boolean $give_context Whether to embed a link to the topic
* @param boolean $include_breadcrumbs Whether to include breadcrumbs (if there are any)
* @param ?AUTO_LINK $root Virtual root to use (null: none)
* @param ID_TEXT $guid Overridden GUID to send to templates (blank: none)
* @param ?Tempcode $text_summary Text summary for result (e.g. highlighted portion of actual file from search result) (null: none)
* @param ID_TEXT $zone The zone to display in
* @return Tempcode The isolated post
*/
function render_post_box(array $row, bool $use_post_title = false, bool $give_context = true, bool $include_breadcrumbs = true, ?int $root = null, string $guid = '', ?object $text_summary = null, string $zone = '_SEARCH') : object
* Show a post, isolated of the other posts in it's topic.
*
* @param array $row The post row
* @param boolean $use_post_title Whether to include context (i.e. say WHAT this is, not just show the actual content). Also uses the post title, as opposed to the post's topic's title.
* @param boolean $give_context Whether to embed a link to the topic
* @param boolean $include_breadcrumbs Whether to include breadcrumbs (if there are any)
* @param ?AUTO_LINK $root Virtual root to use (null: none)
* @param ID_TEXT $guid Overridden GUID to send to templates (blank: none)
* @param ?Tempcode $text_summary Text summary for result (e.g. highlighted portion of actual file from search result) (null: none)
* @param ID_TEXT $zone The zone to display in
* @return Tempcode The isolated post
*/
function render_post_box(array $row, bool $use_post_title = false, bool $give_context = true, bool $include_breadcrumbs = true, ?int $root = null, string $guid = '', ?object $text_summary = null, string $zone = '_SEARCH') : object
