mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-19 02:18:56 +00:00
521b262238
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@209052 c90b9560-bf6c-de11-be94-00142212c4b1
96 lines
3.2 KiB
XML
96 lines
3.2 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.9 $ -->
|
|
<refentry id="function.urlencode">
|
|
<refnamediv>
|
|
<refname>urlencode</refname>
|
|
<refpurpose>URL-encodes string</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>urlencode</methodname>
|
|
<methodparam><type>string</type><parameter>str</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<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 RFC1738 encoding (see
|
|
<function>rawurlencode</function>) in that for historical
|
|
reasons, spaces are encoded as plus (+) signs. 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:
|
|
<example>
|
|
<title><function>urlencode</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
echo '<a href="mycgi?foo=', urlencode($userinput), '">';
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
<para>
|
|
Note: 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:
|
|
<ulink url="&url.argsep;">&url.argsep;</ulink>. 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>
|
|
<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>
|
|
<para>
|
|
See also <function>urldecode</function>,
|
|
<function>htmlentities</function>,
|
|
<function>rawurldecode</function> and
|
|
<function>rawurlencode</function>.
|
|
</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
|
|
-->
|