API16

JUtility/array unshift ref: Difference between revisions

From Joomla! Documentation

Doxiki (talk | contribs)
No edit summary
m clean up
Line 2: Line 2:
Prepend a reference to an element to the beginning of an array. Renumbers numeric keys, so $value is always inserted to $array[0]
Prepend a reference to an element to the beginning of an array. Renumbers numeric keys, so $value is always inserted to $array[0]


<span class="editsection" style="font-size:76%;">
<nowiki>[</nowiki>[[Description:JUtility/array_unshift_ref|Edit Descripton]]<nowiki>]</nowiki>
</span>


{{Description:JUtility/array_unshift_ref}}
 
{{subst:Description:JUtility/array_unshift_ref}}


===Syntax===
===Syntax===
Line 44: Line 42:
</source>
</source>


<span class="editsection" style="font-size:76%;">
 
<nowiki>[</nowiki>[[SeeAlso:JUtility/array_unshift_ref|Edit See Also]]<nowiki>]</nowiki>
{{subst:SeeAlso:JUtility/array_unshift_ref}}
</span>
{{SeeAlso:JUtility/array_unshift_ref}}


===Examples===
===Examples===

Revision as of 14:36, 24 March 2017

Description

Prepend a reference to an element to the beginning of an array. Renumbers numeric keys, so $value is always inserted to $array[0]


{{subst:Description:JUtility/array_unshift_ref}}

Syntax

array_unshift_ref(&$array, &$value)
Parameter Name Default Value Description
&$array array
&$value mixed

Returns

int

Defined in

libraries/joomla/utilities/utility.php

Importing

jimport( 'joomla.utilities.utility' );

Source Body

function array_unshift_ref(&$array, &$value)
{
        $return = array_unshift($array,'');
        $array[0] =& $value;
        return $return;
}


{{subst:SeeAlso:JUtility/array_unshift_ref}}

Examples

<CodeExamplesForm />