JController/setRedirect: Difference between revisions
From Joomla! Documentation
New page: ===Description===
Set a URL for browser redirection.
<span class="editsection" style="font-size:76%;">
<nowiki>[</nowiki>Edit Descripton<nowiki... |
m preparing for archive only |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 3: | Line 3: | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[< | <nowiki>[<! removed edit link to red link >]</nowiki> | ||
</span> | </span> | ||
<! removed transcluded page call, red link never existed > | |||
===Syntax=== | ===Syntax=== | ||
| Line 40: | Line 40: | ||
===Source Body=== | ===Source Body=== | ||
<source lang="php"> | <source lang="php"> | ||
function setRedirect($url, $msg = null, $type = 'message') | function setRedirect( $url, $msg = null, $type = 'message' ) | ||
{ | { | ||
$this->_redirect = $url; | $this->_redirect = $url; | ||
| Line 52: | Line 52: | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[< | <nowiki>[<! removed edit link to red link >]</nowiki> | ||
</span> | </span> | ||
<! removed transcluded page call, red link never existed > | |||
===Examples=== | ===Examples=== | ||
=== Code Examples === | |||
<dpl> | <dpl> | ||
noresultsheader=\n | noresultsheader=\n | ||
category=setRedirect | category=setRedirect | ||
category=JController | category=JController | ||
namespace=CodeExample | |||
category=MethodExample | category=MethodExample | ||
include=* | include=* | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
[[Category:Archived pages API15]] | |||
Latest revision as of 00:24, 25 March 2017
Description
Set a URL for browser redirection.
[<! removed edit link to red link >]
<! removed transcluded page call, red link never existed >
Syntax
setRedirect($url, $msg=null, $type= 'message')
| Parameter Name | Default Value | Description |
|---|---|---|
| $url | URL to redirect to. | |
| $msg | null | Message to display on redirect. Optional, defaults to value set internally by controller, if any. |
| $type | 'message' | Message type. Optional, defaults to 'message'. |
Returns
void
Defined in
libraries/joomla/application/component/controller.php
Importing
jimport( 'joomla.application.component.controller' );
Source Body
function setRedirect( $url, $msg = null, $type = 'message' )
{
$this->_redirect = $url;
if ($msg !== null) {
// controller may have set this directly
$this->_message = $msg;
}
$this->_messageType = $type;
}
[<! removed edit link to red link >] <! removed transcluded page call, red link never existed >
Examples
Code Examples