API16:JError/customErrorPage

Description

Display a custom error page and exit gracefully

<! removed transcluded page call, red link never existed >

Syntax

static customErrorPage(&$error)

Parameter Name	Default Value	Description
&$error		$error object

Returns

void

Defined in

libraries/joomla/error/error.php

Importing

jimport( 'joomla.error.error' );

Source Body

public static function customErrorPage(& $error)
{
        // Initialise variables.
        jimport('joomla.document.document');
        $app            = & JFactory::getApplication();
        $document       = & JDocument::getInstance('error');
        $config         = & JFactory::getConfig();

        // Get the current template from the application
        $template = $app->getTemplate();

        // Push the error object into the document
        $document->setError($error);

        @ob_end_clean();
        $document->setTitle(JText::_('Error').': '.$error->get('code'));
        $data = $document->render(false, array (
                'template' => $template,
                'directory' => JPATH_THEMES,
                'debug' => $config->getValue('config.debug')
        ));

        JResponse::setBody($data);
        echo JResponse::toString();
        $app->close(0);
}

<! removed transcluded page call, red link never existed >