File: headers-sent.xml

package info (click to toggle)
phpdoc 20050512-1
  • links: PTS
  • area: non-free
  • in suites: sarge
  • size: 36,592 kB
  • ctags: 1,501
  • sloc: xml: 376,768; php: 6,708; cpp: 500; makefile: 293; perl: 161; sh: 151; awk: 28
file content (97 lines) | stat: -rw-r--r-- 3,239 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.16 $ -->
<!-- splitted from ./en/functions/http.xml, last change in rev 1.7 -->
  <refentry id="function.headers-sent">
   <refnamediv>
    <refname>headers_sent</refname>
    <refpurpose>Checks if or where headers have been sent</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>bool</type><methodname>headers_sent</methodname>      
      <methodparam choice="opt"><type>string</type><parameter role="reference">file</parameter></methodparam>
      <methodparam choice="opt"><type>int</type><parameter role="reference">line</parameter></methodparam>
     </methodsynopsis>
    <simpara>
     <function>headers_sent</function> will return &false; if no HTTP headers
     have already been sent or &true; otherwise. If the optional
     <parameter>file</parameter> and <parameter>line</parameter> parameters
     are set, <function>headers_sent</function> will put the PHP source
     file name and line number where output started in the <parameter>file</parameter>
     and <parameter>line</parameter> variables.
    </simpara>
    <simpara>
     You can't add any more header lines using the <function>header</function> 
     function once the header block has already been sent. Using this function 
     you can at least prevent getting HTTP header related error messages.
     Another option is to use <link linkend="ref.outcontrol">Output Buffering</link>.
    </simpara>
    <note>
     <simpara>
      The optional <parameter>file</parameter> and <parameter>line</parameter> 
      parameters where added in PHP 4.3.0.
     </simpara>
    </note>
    <para>
     <example>
      <title>Examples using <function>headers_sent</function></title>
      <programlisting role="php">
<![CDATA[
<?php

// If no headers are sent, send one
if (!headers_sent()) {
    header('Location: http://www.example.com/');
    exit;
}
  
// An example using the optional file and line parameters, as of PHP 4.3.0
// Note that $filename and $linenum are passed in for later use.
// Do not assign them values beforehand.
if (!headers_sent($filename, $linenum)) {
    header('Location: http://www.example.com/');
    exit;

// You would most likely trigger an error here.
} else {

    echo "Headers already sent in $filename on line $linenum\n" .
          "Cannot redirect, for now please click this <a " .
          "href=\"http://www.example.com\">link</a> instead\n";
    exit;
}

?>
]]>
      </programlisting>
     </example>
    </para>
    <para>
     See also <function>ob_start</function>, <function>trigger_error</function>, 
     and <function>header</function> for a more detailed discussion of the 
     matters involved.
    </para>
   </refsect1>
  </refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->