php-doc-en/reference/array/functions/array-push.xml
Hannes Magnusson c030e2adf7 Upgrade to DocBook5:
- All id attributes are now xml:id
 - Add docbook namespace to all root elements
 - Replace <ulink /> with <link xlink:href />
 - Minor markup fixes here and there


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@238160 c90b9560-bf6c-de11-be94-00142212c4b1
2007-06-20 22:25:43 +00:00

102 lines
2.7 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.15 $ -->
<!-- splitted from ./en/functions/array.xml, last change in rev 1.2 -->
<refentry xml:id="function.array-push" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>array_push</refname>
<refpurpose>Push one or more elements onto the end of array</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>array_push</methodname>
<methodparam><type>array</type><parameter role="reference">array</parameter></methodparam>
<methodparam><type>mixed</type><parameter>var</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>...</parameter></methodparam>
</methodsynopsis>
<para>
<function>array_push</function> treats
<parameter>array</parameter> as a stack, and pushes the passed
variables onto the end of <parameter>array</parameter>. The
length of <parameter>array</parameter> increases by the number of
variables pushed. Has the same effect as:
<programlisting role="php">
<![CDATA[
<?php
$array[] = $var;
?>
]]>
</programlisting>
repeated for each <parameter>var</parameter>.
</para>
<para>
Returns the new number of elements in the array.
</para>
<para>
<example>
<title><function>array_push</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$stack = array("orange", "banana");
array_push($stack, "apple", "raspberry");
print_r($stack);
?>
]]>
</programlisting>
&example.outputs;
<screen role="php">
<![CDATA[
Array
(
[0] => orange
[1] => banana
[2] => apple
[3] => raspberry
)
]]>
</screen>
</example>
</para>
<note>
<simpara>
If you use <function>array_push</function> to add one element to the
array it's better to use <literal>$array[] = </literal> because in that
way there is no overhead of calling a function.
</simpara>
</note>
<note>
<simpara>
<function>array_push</function> will raise a warning if the first
argument is not an array. This differs from the
<literal>$var[]</literal> behaviour where a new array is created.
</simpara>
</note>
<para>
See also <function>array_pop</function>,
<function>array_shift</function>, and
<function>array_unshift</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
-->