Function Module_cms_wiki->get_page_fields

Definitions

cms/pages/modules/cms_wiki.php

  • Get the fields for adding/editing a Wiki+ page.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: array

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$id ?AUTO_LINK No No Null N/A N/A The page ID (null: new)
$title SHORT_TEXT No No Blank (empty string) N/A N/A The page title
$notes LONG_TEXT No No Blank (empty string) N/A N/A Hidden notes pertaining to the page
$show_posts BINARY No No 1 N/A N/A Whether to show the posts on the page by default
$page_id ?AUTO_LINK No No Null N/A N/A The ID of the page (null: we're adding)

Returns

  • The fields, the extra fields, the hidden fields
  • Type: array
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get the fields for adding/editing a Wiki+ page.
 *
 * @param  ?AUTO_LINK $id The page ID (null: new)
 * @param  SHORT_TEXT $title The page title
 * @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  ?AUTO_LINK $page_id The ID of the page (null: we're adding)
 * @return array The fields, the extra fields, the hidden fields
 */
public function get_page_fields(?int $id = null, string $title = '', string $notes = '', int $show_posts = 1, ?int $page_id = null) : array