Function __global->wiki_edit_page
Definitions
sources/wiki.php
- Edit a Wiki+ page.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $page_id | AUTO_LINK | No | No | required parameter | N/A | N/A | The page ID |
| $title | SHORT_TEXT | No | No | required parameter | N/A | N/A | The page title |
| $description | LONG_TEXT | No | No | required parameter | N/A | N/A | The page description |
| $notes | LONG_TEXT | No | No | required parameter | N/A | N/A | Hidden notes pertaining to the page |
| $show_posts | BINARY | No | No | required parameter | N/A | N/A | Whether to show the posts on the page by default |
| $meta_keywords | SHORT_TEXT | No | No | required parameter | N/A | N/A | Meta keywords |
| $meta_description | LONG_TEXT | No | No | required parameter | N/A | N/A | Meta description |
| $member_id | ?MEMBER | No | No | Null | N/A | N/A | The member doing the action (null: current member) |
| $edit_time | ?TIME | No | No | Null | N/A | N/A | Edit time (null: either means current time, or if $null_is_literal, means reset to to null) |
| $add_time | ?TIME | No | No | Null | N/A | N/A | Add time (null: do not change) |
| $views | ?integer | No | No | Null | N/A | N/A | Views (null: do not change) |
| $null_is_literal | boolean | No | No | False | N/A | N/A | Determines whether some nulls passed mean 'use a default' or literally mean 'set to null' |
Preview
Code (PHP)
/**
* Edit a Wiki+ page.
*
* @param AUTO_LINK $page_id The page ID
* @param SHORT_TEXT $title The page title
* @param LONG_TEXT $description The page description
* @param LONG_TEXT $notes Hidden notes pertaining to the page
* @param BINARY $show_posts Whether to show the posts on the page by default
* @param SHORT_TEXT $meta_keywords Meta keywords
* @param LONG_TEXT $meta_description Meta description
* @param ?MEMBER $member_id The member doing the action (null: current member)
* @param ?TIME $edit_time Edit time (null: either means current time, or if $null_is_literal, means reset to to null)
* @param ?TIME $add_time Add time (null: do not change)
* @param ?integer $views Views (null: do not change)
* @param boolean $null_is_literal Determines whether some nulls passed mean 'use a default' or literally mean 'set to null'
*/
function wiki_edit_page(int $page_id, string $title, string $description, string $notes, int $show_posts, string $meta_keywords, string $meta_description, ?int $member_id = null, ?int $edit_time = null, ?int $add_time = null, ?int $views = null, bool $null_is_literal = false)
* Edit a Wiki+ page.
*
* @param AUTO_LINK $page_id The page ID
* @param SHORT_TEXT $title The page title
* @param LONG_TEXT $description The page description
* @param LONG_TEXT $notes Hidden notes pertaining to the page
* @param BINARY $show_posts Whether to show the posts on the page by default
* @param SHORT_TEXT $meta_keywords Meta keywords
* @param LONG_TEXT $meta_description Meta description
* @param ?MEMBER $member_id The member doing the action (null: current member)
* @param ?TIME $edit_time Edit time (null: either means current time, or if $null_is_literal, means reset to to null)
* @param ?TIME $add_time Add time (null: do not change)
* @param ?integer $views Views (null: do not change)
* @param boolean $null_is_literal Determines whether some nulls passed mean 'use a default' or literally mean 'set to null'
*/
function wiki_edit_page(int $page_id, string $title, string $description, string $notes, int $show_posts, string $meta_keywords, string $meta_description, ?int $member_id = null, ?int $edit_time = null, ?int $add_time = null, ?int $views = null, bool $null_is_literal = false)
