mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-01-18 22:08:20 +01:00
Code Issues Projects Releases Wiki Activity

Improving phpdocs for when to use format_string()/format_text() based on

Browse Source 
wiki comments. It wasn't an entirely clear (e.g. mixup in MDL-11800)

Merged from MOODLE_19_STABLE
This commit is contained in:
poltawski 2007-12-15 18:42:49 +00:00
parent 8b3dc20253
commit e8276c1047
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
lib/weblib.php
View File

@ -1394,6 +1394,9 @@ function format_text_menu() {
* Given text in a variety of format codings, this function returns
* the text as safe HTML.
*
* This function should mainly be used for long strings like posts,
* answers, glossary items etc. For short strings @see format_string().
*
* @uses $CFG
* @uses FORMAT_MOODLE
* @uses FORMAT_HTML
@ -1579,7 +1582,11 @@ function text_format_name( $key ) {
/** Given a simple string, this function returns the string
* processed by enabled filters if $CFG->filterall is enabled
* processed by enabled string filters if $CFG->filterall is enabled
*
* This function should be used to print short strings (non html) that
* need filter processing e.g. activity titles, post subjects,
* glossary concepts.
*
* @param string $string The string to be filtered.
* @param boolean $striplinks To strip any link in the result text (Moodle 1.8 default changed from false to true! MDL-8713)