Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
filter

Classes

class  filter_activitynames
 Activity name filtering. More...
 
class  filter_algebra
 
class  filter_emoticon
 
class  filter_glossary
 Glossary linking filter class. More...
 
class  filter_mediaplugin
 Automatic media embedding filter class. More...
 
class  filter_tidy
 
class  filter_urltolink
 

Functions

 filter_algebra_image ($imagefile, $tex="", $height="", $width="", $align="middle")
 
 filter_tex_get_cmd ($pathname, $texexp)
 
 filter_tex_get_executable ($debug=false)
 
 filter_tex_sanitize_formula (string $texexp)
 Check the formula expression against the list of denied keywords.
 
 filter_tex_updatedcallback ($name)
 Purge all caches when settings changed.
 
 filter_text_image ($imagefile, $tex, $height, $width, $align, $alt)
 Create TeX image link.
 
 filter_urltolink_img_callback ($link)
 Change links to images into embedded images.
 
 xmldb_filter_data_install ()
 
 xmldb_filter_glossary_install ()
 
 xmldb_filter_mathjaxloader_install ()
 
 xmldb_filter_mediaplugin_install ()
 
 xmldb_filter_mediaplugin_upgrade ($oldversion)
 
 xmldb_filter_tex_install ()
 
 xmldb_filter_tex_upgrade ($oldversion)
 

Variables

 $plugin = 2024041600
 
 $plugin = 2024041600
 
 $plugin = 2024041600
 
 $plugin = 2024041600
 
 $plugin = 2024041600
 
 $plugin = 2024041600
 
 $plugin = 2024041600
 
 $plugin = 2024041600
 
 $plugin = 2024041600
 
$plugin component = 'filter_activitynames'
 
$plugin component = 'filter_algebra'
 
$plugin component = 'filter_data'
 
$plugin component = 'filter_emailprotect'
 
$plugin component = 'filter_glossary'
 
$plugin component = 'filter_mediaplugin'
 
$plugin component = 'filter_multilang'
 
$plugin component = 'filter_tex'
 
$plugin component = 'filter_tidy'
 
$plugin dependencies = ['mod_data' => 2024041600]
 
$plugin dependencies = ['mod_glossary' => 2024041600]
 
$plugin version = 2024042200
 
$plugin version = 2024042200
 
$plugin version = 2024042200
 
$plugin version = 2024042200
 
$plugin version = 2024042200
 
$plugin version = 2024042200
 
$plugin version = 2024042200
 
$plugin version = 2024042200
 
$plugin version = 2024042200
 

Detailed Description

Function Documentation

◆ filter_tex_sanitize_formula()

filter_tex_sanitize_formula ( string $texexp)

Check the formula expression against the list of denied keywords.

List of allowed could be more complete but also harder to maintain.

Parameters
string$texexpFormula expression to check.
Return values
stringFormula expression with denied keywords replaced with 'forbiddenkeyword'.

◆ filter_text_image()

filter_text_image ( $imagefile,
$tex,
$height,
$width,
$align,
$alt )

Create TeX image link.

Parameters
string$imagefilename of file
string$texTeX notation (html entities already decoded)
int$heightO means automatic
int$widthO means automatic
string$align
string$alt
Return values
stringHTML markup

◆ filter_urltolink_img_callback()

filter_urltolink_img_callback ( $link)

Change links to images into embedded images.

This plugin is intended for automatic conversion of image URLs when FORMAT_MOODLE used.

Parameters
$link
Return values
string

◆ xmldb_filter_mediaplugin_upgrade()

xmldb_filter_mediaplugin_upgrade ( $oldversion)
Parameters
int$oldversionthe version we are upgrading from
Return values
boolresult

◆ xmldb_filter_tex_upgrade()

xmldb_filter_tex_upgrade ( $oldversion)
Parameters
int$oldversionthe version we are upgrading from
Return values
boolresult