Document PMA_sanitize.
This commit is contained in:

committed by
Michal Čihař

parent
a4a54da173
commit
0fe30236fa
@@ -7,11 +7,20 @@
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Sanitizes $message, taking into account our special codes
|
* Sanitizes $message, taking into account our special codes
|
||||||
* for formatting
|
* for formatting.
|
||||||
|
*
|
||||||
|
* If you want to include result in element attribute, you should escape it.
|
||||||
|
*
|
||||||
|
* Examples:
|
||||||
|
*
|
||||||
|
* <p><?php echo PMA_sanitize($foo); ?></p>
|
||||||
|
*
|
||||||
|
* <a title="<?php echo PMA_sanitize($foo, true); ?>">bar</a>
|
||||||
*
|
*
|
||||||
* @uses preg_replace()
|
* @uses preg_replace()
|
||||||
* @uses strtr()
|
* @uses strtr()
|
||||||
* @param string the message
|
* @param string the message
|
||||||
|
* @param boolean whether to escape html in result
|
||||||
*
|
*
|
||||||
* @return string the sanitized message
|
* @return string the sanitized message
|
||||||
*
|
*
|
||||||
|
Reference in New Issue
Block a user