Back to Toolbar class

Method prependButton

public \Joomla\CMS\Toolbar\ToolbarButton|bool
prependButton
(mixed $button, mixed $args)
Prepend a button to toolbar.
Parameters
  • \Joomla\CMS\Toolbar\ToolbarButton $button The button instance.
  • array $args The more arguments.
Returns
  • \Joomla\CMS\Toolbar\ToolbarButton|bool Return button instance to help chaining configure. If using legacy arguments returns true
Since
  • 1.5
Class: Toolbar
Project: Joomla

Method prependButton - Source code

/**
 * Prepend a button to toolbar.
 *
 * @param   ToolbarButton  $button  The button instance.
 * @param   array          $args    The more arguments.
 *
 * @return  ToolbarButton|boolean  Return button instance to help chaining configure. If using legacy arguments
 *                                 returns true
 *
 * @since   1.5
 */
public function prependButton($button, ...$args)
{
    if ($button instanceof ToolbarButton) {
        $button->setParent($this);
        array_unshift($this->_bar, $button);
        return $button;
    }
    // B/C
    array_unshift($args, $button);
    array_unshift($this->_bar, $args);
    @trigger_error(sprintf('%s::prependButton() should only accept %s instance in Joomla 5.0.', static::class, ToolbarButton::class), E_USER_DEPRECATED);
    return true;
}