JHTMLContent/prepare: Difference between revisions

Revision as of 17:23, 12 May 2013

Description

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

[<! removed edit link to red link >]

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

Syntax

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

function prepare($text, $params = null)
{
        if ($params === null) {
                $params = array();
        }
        /*
         * Create a skeleton of an article. This is a bit of a hack.
         */
        $nodb = null;
        $article = new JTableContent($nodb);
        $article->text = $text;
        JPluginHelper::importPlugin('content');
        $dispatcher = &JDispatcher::getInstance();
        $results = $dispatcher->trigger(
                'onPrepareContent', array (&$article, &$params, 0)
        );

        return $article->text;
}

[<! removed edit link to red link >] <! removed transcluded page call, red link never existed >

Examples

@@ Line 3: / Line 3: @@
 <span class="editsection" style="font-size:76%;">
-	<nowiki>[</nowiki>[[Description:JHTMLContent/prepare|Edit Descripton]]<nowiki>]</nowiki>
+	<nowiki>[<! removed edit link to red link >]</nowiki>
 </span>
-{{Description:JHTMLContent/prepare}}
+<! removed transcluded page call, red link never existed >
 ===Syntax===
@@ Line 58: / Line 58: @@
 <span class="editsection" style="font-size:76%;">
-	<nowiki>[</nowiki>[[SeeAlso:JHTMLContent/prepare|Edit See Also]]<nowiki>]</nowiki>
+	<nowiki>[<! removed edit link to red link >]</nowiki>
 </span>
-{{SeeAlso:JHTMLContent/prepare}}
+<! removed transcluded page call, red link never existed >
 ===Examples===
@@ Line 73: / Line 73: @@
   format= ,,,
 </dpl>
+[[Category:Archived pages API15]]

API15