API16

API16:JUtility/array unshift ref

From Joomla! Documentation

Revision as of 14:36, 24 March 2017 by JoomlaWikiBot (talk | contribs) (clean up)

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 />