vBulletin LTS

Cel PHP in Custom BBCode
Mod Version: 4.001, by cellarius

It offers a framework for the easy integration and sharing of custom BBCodes that are based on PHP processing of the data entered by the user. It could, for example, be used to develop BBCodes that use multiple options or to poll database information. It does allow for the Admin to use PHP in the Backend - it does, of course, not allow this to forum visitors.

You need to know PHP to use this Addon to develop your own PHP based bbcodes, however it would be possible to share them as an extension to this addon.

Installation:
- install the product file - done.

Using PHP in Custom BBCodes:
Create your Custom BBCode as always, and just put your PHP into the Replacement box (where the HTML used to go).

Just remember two things:

• Your code needs to start with <?php
• You need to return the result of your code.

If you're unsure what that means, read the php manual on eval() and look at the evaltest example in the second post

Spoiler (click to open)

PHP BBCode Examples:

To test them, go to AdminCP->Custom BB Codes->Add new BB Code and fill in the form:

--------------------------------------------------------------------

• Title: evaltest
• BBCode Tag Name: evaltest
• Replacement:

PHP Code:

<?php
/* 
Please note: 
  
- available variables: 
    param => $value, option => $option
    remember: [bbcode=option]param[/bbcode] 

- pass your result via return (as needed for PHP eval)
    so end your code with return $my_result */

$my_result = "Test per eval (here no option was used):  "; 
$my_result .= "Parameter: <strong>" . $value . "</strong>";

return $my_result; ?>

• Example: [evaltest]Hello World![/evaltest]
• Use {option}: No

--------------------------------------------------------------------

• Title: includetest
• BBCode Tag Name: includetest
• Replacement:

[code]include[code]

• Example: [includetest="World!"]Hello![/includetest]
• Use {option}: Yes

Additionally, you need to create a directory called custombbcodes, and in it create a file called includetest.php with the following code:

PHP Code:

<?php
    /* 
Please note:
   
- available variables: 
    param => $value, option => $option
    remember: [bbcode=option]param[/bbcode] 
- all output needs to go to $parsed
    no return statement needed (different from direct eval method)
    so don't use echo "Hello World", but $parsed = "Hello World"
*/

$parsed = "Test per include (here option was used): ";
$parsed .= "Parameter = <strong>" . $value . "</strong>, ";
$parsed .= "Option = <strong>" . $option . "</strong>";

--------------------------------------------------------------------

Close

.

For coders: include instead of eval
If you'd rather store the PHP for your new BBCodes in the file system for ease of development, that's possible, too:

• create a folder called "custombbcodes" in your forum root
• in that folder, create a php file that copies your BBCode Tag Name (ie. if your tag name is "includetest", the file needs to be called "includetest.php"). That's where your PHP goes.
• in the Replacement box in the Custom BBCode Dialog, just put the word "include", nothing else
• Since there's no eval() here, no need to return the result. Instead, it needs to go into $parsed.There's also an includetest example in the second post

  Spoiler (click to open)

  
  

  PHP BBCode Examples:
  
  To test them, go to AdminCP->Custom BB Codes->Add new BB Code and fill in the form:
  
  --------------------------------------------------------------------

  • Title: evaltest
  • BBCode Tag Name: evaltest
  • Replacement:

  PHP Code:

  <?php
/* 
Please note: 
  
- available variables: 
    param => $value, option => $option
    remember: [bbcode=option]param[/bbcode] 

- pass your result via return (as needed for PHP eval)
    so end your code with return $my_result */

$my_result = "Test per eval (here no option was used):  "; 
$my_result .= "Parameter: <strong>" . $value . "</strong>";

return $my_result; ?>

  • Example: [evaltest]Hello World![/evaltest]
  • Use {option}: No

  --------------------------------------------------------------------

  • Title: includetest
  • BBCode Tag Name: includetest
  • Replacement:

  [code]include[code]

  • Example: [includetest="World!"]Hello![/includetest]
  • Use {option}: Yes

  Additionally, you need to create a directory called custombbcodes, and in it create a file called includetest.php with the following code:
  

  PHP Code:

  <?php
    /* 
Please note:
   
- available variables: 
    param => $value, option => $option
    remember: [bbcode=option]param[/bbcode] 
- all output needs to go to $parsed
    no return statement needed (different from direct eval method)
    so don't use echo "Hello World", but $parsed = "Hello World"
*/

$parsed = "Test per include (here option was used): ";
$parsed .= "Parameter = <strong>" . $value . "</strong>, ";
$parsed .= "Option = <strong>" . $option . "</strong>";

  --------------------------------------------------------------------

  
  

  Close
  .