You are here

Home » API reference » Extensible BBCode 5

README.txt in Extensible BBCode 5

Same filename and directory in other branches
  1. 8 README.txt
  2. 8.2 README.txt
  3. 6 README.txt
  4. 7 README.txt
Here's a brief description of the API hook that XBBCode provides. It will eventually become a proper
documentation page.

To provide custom BBCode tags, your module should implement a function similar to this:

---------

function hook_xbbcode($op,$delta=NULL,$tag=NULL) 
{
  switch($op) 
  {
  case 'list': return array('i','url','wordcount');
  case 'info':
    switch($delta)
    {
      case 'i': return array('replacewith'=>'<em>{content}</em>');
      case 'url': return array('replacewith'=>l('{content}','{option}'));
      case 'wordcount': return array('dynamic'=>'true');
    )
    return array();
  case 'render': 
    switch ($delta) 
    {
      case 'wordcount':
      return $tag-content . "<hr />".str_word_count($tag->content) . " words.";
    }
    return $tag->content;
  }
}

File

README.txt
View source 
  1. Here's a brief description of the API hook that XBBCode provides. It will eventually become a proper

  2. documentation page.

  3. 

  4. To provide custom BBCode tags, your module should implement a function similar to this:

  5. 

  6. ---------

  7. 

  8. function hook_xbbcode($op,$delta=NULL,$tag=NULL) 

  9. {

  10.   switch($op) 

  11.   {

  12.   case 'list': return array('i','url','wordcount');

  13.   case 'info':

  14.     switch($delta)

  15.     {

  16.       case 'i': return array('replacewith'=>'{content}');

  17.       case 'url': return array('replacewith'=>l('{content}','{option}'));

  18.       case 'wordcount': return array('dynamic'=>'true');

  19.     )

  20.     return array();

  21.   case 'render': 

  22.     switch ($delta) 

  23.     {

  24.       case 'wordcount':

  25.       return $tag-content . "
    ".str_word_count($tag->content) . " words.";

  26.     }

  27.     return $tag->content;

  28.   }

  29. }