SproutCMS

This is the code documentation for the SproutCMS project

function getText()

Get the page text for a page id, in HTML format, with widgets and everything, ready to go

Usage

string Page::getText ( int $page_id [, int $rev_id [, int $subsite_id ]] );

Arguments

  1. int $page_id
    Page ID from database
  2. int $rev_id = 0
    If specified, that revision will be used.
           Otherwise, the current live revision will be used.
           N.B. if specified, it must be a valid revision for the specified page
  3. int $subsite_id = NULL
    Optional subsite ID - this is required for admins editing a sub-site
             that's different from the domain

Exceptions thrown

  • QueryException

Return value

  • string
    HTML