API16:JHtmlContent/prepare

This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

Description

Fire onPrepareContent for content that isn't part of an article.

Syntax

static prepare($text, $params=null)

Parameter Name	Default Value	Description
$text		The content to be transformed.
$params	null	The content params.

Returns

string The content after transformation.

Defined in

libraries/joomla/html/html/content.php

Importing

jimport( 'joomla.html.html.content' );

Source Body

public static function prepare($text, $params = null)
{
        if ($params === null) {
                $params = array();
        }
        $article = new stdClass;
        $article->text = $text;
        JPluginHelper::importPlugin('content');
        $dispatcher = &JDispatcher::getInstance();
        $results = $dispatcher->trigger(
                'onPrepareContent', array (&$article, &$params, 0)
        );
 
        return $article->text;
}

Examples

<CodeExamplesForm />