Function Module_wiki->_render_screen_buttons

Definitions

site/pages/modules/wiki.php

  • Show the buttons on the Wiki+ page viewing screen.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: object

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$chain SHORT_TEXT No No required parameter N/A N/A The ID chain being used to get to this page
$id AUTO_LINK No No required parameter N/A N/A The ID of the page we are showing the menu on
$may_post boolean No No True N/A N/A Whether posting is generally allowed (may be passed false if too many posts)

Returns

  • The button Tempcode
  • Type: Tempcode
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Show the buttons on the Wiki+ page viewing screen.
 *
 * @param  SHORT_TEXT $chain The ID chain being used to get to this page
 * @param  AUTO_LINK $id The ID of the page we are showing the menu on
 * @param  boolean $may_post Whether posting is generally allowed (may be passed false if too many posts)
 * @return Tempcode The button Tempcode
 */
public function _render_screen_buttons(string $chain, int $id, bool $may_post = true) : object