API15:JResponse/setHeader

This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

Description

Set a header

Syntax

setHeader($name, $value, $replace=false)

Parameter Name	Default Value	Description
$name		$name
$value		$value
$replace	false	$replace

Defined in

libraries/joomla/environment/response.php

Importing

jimport( 'joomla.environment.response' );

Source Body

function setHeader($name, $value, $replace = false)
{
        $name   = (string) $name;
        $value  = (string) $value;
 
        if ($replace)
        {
                foreach ($GLOBALS['_JRESPONSE']->headers as $key => $header) {
                        if ($name == $header['name']) {
                                unset($GLOBALS['_JRESPONSE']->headers[$key]);
                        }
                }
        }
 
        $GLOBALS['_JRESPONSE']->headers[] = array(
                'name'  => $name,
                'value' => $value
        );
}

Examples

<CodeExamplesForm />