internal package Foswiki::UI::Rename

See PublishedAPI for packages intended to be used by Plugin and Contrib authors, or browse all packages.
See also Developing plugins, Developer's Bible, Technical Overview

Perl Module:

Child packagesChild packages

internal package Foswiki::UI::Rename

UI functions for renaming.

StaticMethod rename( $session )

rename command handler. This method is designed to be invoked via the UI::run method. Rename the given topic. Details of the new topic name are passed in CGI parameters:

skin	skin(s) to use
newweb	new web name
newtopic	new topic name
breaklock
attachment
confirm	if defined, requires a second level of confirmation
currentwebonly	if defined, searches current web only for links to this topic
onlywikiname	if defined, only a wikiword is acceptable for the new topic name
redirectto	If the rename process is successful, rename will redirect to this topic or URL. The parameter value can be a TopicName, a Web.TopicName, or a URL. Note: Redirect to a URL only works if it is enabled in configure (Miscellaneous {AllowRedirectUrl}).