public
object
|
#
editPage( string $title, integer $section = null, string $sectiontitle = null, string $text = null, string $summary = null )
Method to edit a page.
Parameters
- $title
string - $title Page title.- $section
integer - $section Section number.- $sectiontitle
string - $sectiontitle The title for a new section.- $text
string - $text Page content.- $summary
string - $summary Title of the page you want to delete. Returns
object
Since
12.3
|
public
object
|
#
deletePageByName( string $title, string $reason = null, string $watchlist = null, string $oldimage = null )
Method to delete a page.
Parameters
- $title
string - $title Title of the page you want to delete.- $reason
string - $reason Reason for the deletion.- $watchlist
string - $watchlist Unconditionally add or remove the page from your watchlis.- $oldimage
string - $oldimage The name of the old image to delete. Returns
object
Since
12.3
|
public
object
|
#
deletePageById( string $pageid, string $reason = null, string $watchlist = null, string $oldimage = null )
Method to delete a page.
Parameters
- $pageid
string - $pageid Page ID of the page you want to delete.- $reason
string - $reason Reason for the deletion.- $watchlist
string - $watchlist Unconditionally add or remove the page from your watchlis.- $oldimage
string - $oldimage The name of the old image to delete. Returns
object
Since
12.3
|
public
object
|
#
undeletePage( string $title, string $reason = null, string $timestamp = null, string $watchlist = null )
Method to restore certain revisions of a deleted page.
Method to restore certain revisions of a deleted page.
Parameters
- $title
string - $title Title of the page you want to restore.- $reason
string - $reason Reason for restoring (optional).- $timestamp
string - $timestamp Timestamps of the revisions to restore.- $watchlist
string - $watchlist Unconditionally add or remove the page from your watchlist. Returns
object
Since
12.3
|
public
object
|
#
movePageByName( string $from, string $to, string $reason = null, string $movetalk = null, string $movesubpages = null, boolean $noredirect = null, string $watchlist = null, boolean $ignorewarnings = null )
Method to move a page.
Parameters
- $from
string - $from Title of the page you want to move.- $to
string - $to Title you want to rename the page to.- $reason
string - $reason Reason for the move (optional).- $movetalk
string - $movetalk Move the talk page, if it exists.- $movesubpages
string - $movesubpages Move subpages, if applicable.- $noredirect
boolean - $noredirect Don't create a redirect.- $watchlist
string - $watchlist Unconditionally add or remove the page from your watchlist.- $ignorewarnings
boolean - $ignorewarnings Ignore any warnings. Returns
object
Since
12.3
|
public
object
|
#
movePageById( integer $fromid, string $to, string $reason = null, string $movetalk = null, string $movesubpages = null, boolean $noredirect = null, string $watchlist = null, boolean $ignorewarnings = null )
Method to move a page.
Parameters
- $fromid
integer - $fromid Page ID of the page you want to move.- $to
string - $to Title you want to rename the page to.- $reason
string - $reason Reason for the move (optional).- $movetalk
string - $movetalk Move the talk page, if it exists.- $movesubpages
string - $movesubpages Move subpages, if applicable.- $noredirect
boolean - $noredirect Don't create a redirect.- $watchlist
string - $watchlist Unconditionally add or remove the page from your watchlist.- $ignorewarnings
boolean - $ignorewarnings Ignore any warnings. Returns
object
Since
12.3
|
public
object
|
#
rollback( string $title, string $user, string $summary = null, string $markbot = null, string $watchlist = null )
Method to undo the last edit to the page.
Method to undo the last edit to the page.
Parameters
- $title
string - $title Title of the page you want to rollback.- $user
string - $user Name of the user whose edits are to be rolled back.- $summary
string - $summary Custom edit summary. If not set, default summary will be used.- $markbot
string - $markbot Mark the reverted edits and the revert as bot edits.- $watchlist
string - $watchlist Unconditionally add or remove the page from your watchlist. Returns
object
Since
12.3
|
public
object
|
#
changeProtection( string $title, string $protections, string $expiry = null, string $reason = null, string $cascade = null, string $watchlist = null )
Method to change the protection level of a page.
Method to change the protection level of a page.
Parameters
- $title
string - $title Title of the page you want to (un)protect.- $protections
string - $protections Pipe-separated list of protection levels.- $expiry
string - $expiry Expiry timestamps.- $reason
string - $reason Reason for (un)protecting (optional).- $cascade
string - $cascade Enable cascading protection.- $watchlist
string - $watchlist Unconditionally add or remove the page from your watchlist. Returns
object
Since
12.3
|
public
object
|
#
getPageInfo( array $titles, array $inprop = null, array $intoken = null, boolean $incontinue = null )
Method to get basic page information.
Method to get basic page information.
Parameters
- $titles
array - $titles Page titles to retrieve info.- $inprop
array - $inprop Which additional properties to get.- $intoken
array - $intoken Request a token to perform a data-modifying action on a page- $incontinue
boolean - $incontinue When more results are available, use this to continue. Returns
object
Since
12.3
|
public
object
|
#
getPageProperties( array $titles, boolean $ppcontinue = null, string $ppprop = null )
Method to get various properties defined in the page content.
Method to get various properties defined in the page content.
Parameters
- $titles
array - $titles Page titles to retrieve properties.- $ppcontinue
boolean - $ppcontinue When more results are available, use this to continue.- $ppprop
string - $ppprop Page prop to look on the page for. Returns
object
Since
12.3
|
public
object
|
#
getRevisions( array $titles, array $rvprop = null, boolean $rvparse = null, integer $rvlimit = null )
Method to get a list of revisions.
Method to get a list of revisions.
Parameters
- $titles
array - $titles Page titles to retrieve revisions.- $rvprop
array - $rvprop Which properties to get for each revision.- $rvparse
boolean - $rvparse Parse revision content.- $rvlimit
integer - $rvlimit Limit how many revisions will be returned. Returns
object
Since
12.3
|
public
object
|
#
getPageTemplates( array $titles, array $tlnamespace = null, integer $tllimit = null, boolean $tlcontinue = null, string $tltemplates = null, string $tldir = null )
Method to get all page templates from the given page.
Method to get all page templates from the given page.
Parameters
- $titles
array - $titles Page titles to retrieve templates.- $tlnamespace
array - $tlnamespace Show templates in this namespace(s) only.- $tllimit
integer - $tllimit How many templates to return.- $tlcontinue
boolean - $tlcontinue When more results are available, use this to continue.- $tltemplates
string - $tltemplates Only list these templates.- $tldir
string - $tldir The direction in which to list. Returns
object
Since
12.3
|
public
object
|
#
getBackLinks( string $bltitle, integer $blpageid = null, boolean $blcontinue = null, array $blnamespace = null, string $blfilterredirect = null, integer $bllimit = null, boolean $blredirect = null )
Method to get all pages that link to the given page.
Method to get all pages that link to the given page.
Parameters
- $bltitle
string - $bltitle Title to search.- $blpageid
integer - $blpageid Pageid to search.- $blcontinue
boolean - $blcontinue When more results are available, use this to continue.- $blnamespace
array - $blnamespace The namespace to enumerate.- $blfilterredirect
string - $blfilterredirect How to filter for redirects..- $bllimit
integer - $bllimit How many total pages to return.- $blredirect
boolean - $blredirect If linking page is a redirect, find all pages that link to that
redirect as well. Returns
object
Since
12.3
|
public
object
|
#
getIWBackLinks( string $iwbltitle, string $iwblprefix = null, boolean $iwblcontinue = null, integer $iwbllimit = null, array $iwblprop = null )
Method to get all pages that link to the given interwiki link.
Method to get all pages that link to the given interwiki link.
Parameters
- $iwbltitle
string - $iwbltitle Interwiki link to search for. Must be used with iwblprefix.- $iwblprefix
string - $iwblprefix Prefix for the interwiki.- $iwblcontinue
boolean - $iwblcontinue When more results are available, use this to continue.- $iwbllimit
integer - $iwbllimit How many total pages to return.- $iwblprop
array - $iwblprop Which properties to get. Returns
object
Since
12.3
|
public
object
|
#
getToken( string $user, string $intoken )
Method to get access token.
Method to get access token.
Parameters
- $user
string - $user The User to get token.- $intoken
string - $intoken The type of token. Returns
object
Since
12.1
|
JMediawikiPages