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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297028 $ -->
<refentry xml:id="function.urlencode" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>urlencode</refname>
<refpurpose>URL-encodes string</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>urlencode</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
</methodsynopsis>
<para>
This function is convenient when encoding a string to be used in a query
part of a URL, as a convenient way to pass variables to the next page.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>str</parameter></term>
<listitem>
<para>
The string to be encoded.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a string in which all non-alphanumeric characters except
<literal>-_.</literal> have been replaced with a percent
(<literal>%</literal>) sign followed by two hex digits and spaces encoded
as plus (<literal>+</literal>) signs. It is encoded the same way that the
posted data from a WWW form is encoded, that is the same way as in
<literal>application/x-www-form-urlencoded</literal> media type. This
differs from the <link xlink:href="&url.rfc;1738">RFC 1738</link> encoding (see
<function>rawurlencode</function>) in that for historical reasons, spaces
are encoded as plus (+) signs.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>urlencode</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
echo '<a href="mycgi?foo=', urlencode($userinput), '">';
?>
]]>
</programlisting>
</example>
</para>
<para>
<example>
<title><function>urlencode</function> and <function>htmlentities</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$query_string = 'foo=' . urlencode($foo) . '&bar=' . urlencode($bar);
echo '<a href="mycgi?' . htmlentities($query_string) . '">';
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
Be careful about variables that may match HTML entities. Things like
&amp, &copy and &pound are parsed by the browser and the
actual entity is used instead of the desired variable name. This is an
obvious hassle that the W3C has been telling people about for years.
The reference is here: <link xlink:href="&url.argsep;">&url.argsep;</link>.
</para>
<para>
PHP supports changing the argument separator to the W3C-suggested
semi-colon through the arg_separator .ini directive. Unfortunately most
user agents do not send form data in this semi-colon separated format.
A more portable way around this is to use &amp; instead of & as
the separator. You don't need to change PHP's arg_separator for this.
Leave it as &, but simply encode your URLs using
<function>htmlentities</function> or
<function>htmlspecialchars</function>.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>urldecode</function></member>
<member><function>htmlentities</function></member>
<member><function>rawurlencode</function></member>
<member><function>rawurldecode</function></member>
</simplelist>
</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:"~/.phpdoc/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
-->
|
