mirror of
https://github.com/php/doc-en.git
synced 2026-03-24 15:52:15 +01:00
d93972fb2d
There is no need to describe the behavior on passing an unsupported type at all, since that is already documented generally for internal functions.
115 lines
2.6 KiB
XML
115 lines
2.6 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.array-pop">
|
|
<refnamediv>
|
|
<refname>array_pop</refname>
|
|
<refpurpose>Pop the element off the end of array</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>mixed</type><methodname>array_pop</methodname>
|
|
<methodparam><type>array</type><parameter role="reference">array</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
<function>array_pop</function> pops and returns the value of
|
|
the last element of <parameter>array</parameter>, shortening the
|
|
<parameter>array</parameter> by one element.
|
|
</para>
|
|
&array.resetspointer;
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>array</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The array to get the value from.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns the value of the last element of <parameter>array</parameter>.
|
|
If <parameter>array</parameter> is empty,
|
|
&null; will be returned.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>array_pop</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$stack = array("orange", "banana", "apple", "raspberry");
|
|
$fruit = array_pop($stack);
|
|
print_r($stack);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
<para>
|
|
After this, <varname>$stack</varname> will have only 3 elements:
|
|
</para>
|
|
<screen role="php">
|
|
<![CDATA[
|
|
Array
|
|
(
|
|
[0] => orange
|
|
[1] => banana
|
|
[2] => apple
|
|
)
|
|
]]>
|
|
</screen>
|
|
<para>
|
|
and <literal>raspberry</literal> will be assigned to
|
|
<varname>$fruit</varname>.
|
|
</para>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>array_push</function></member>
|
|
<member><function>array_shift</function></member>
|
|
<member><function>array_unshift</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
|
|
-->
|