Function __global->wiki_edit_post

Definitions

sources/wiki.php

  • Edit a Wiki+ post.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$post_id AUTO_LINK No No required parameter N/A N/A The post ID
$message string No No required parameter N/A N/A The new post
$validated BINARY No No required parameter N/A N/A Whether the post will be validated
$member_id ?MEMBER No No Null N/A N/A The member doing the action (null: current member)
$page_id ?AUTO_LINK No No Null N/A N/A The page ID (null: do not change)
$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 Number of 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+ post.
 *
 * @param  AUTO_LINK $post_id The post ID
 * @param  string $message The new post
 * @param  BINARY $validated Whether the post will be validated
 * @param  ?MEMBER $member_id The member doing the action (null: current member)
 * @param  ?AUTO_LINK $page_id The page ID (null: do not change)
 * @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 Number of 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_post(int $post_id, string $message, int $validated, ?int $member_id = null, ?int $page_id = null, ?int $edit_time = null, ?int $add_time = null, ?int $views = null, bool $null_is_literal = false)