Developer Documentation

  • Bug fixes for general core bugs in 2.9.x ended 9 May 2016 (12 months).
  • Bug fixes for security issues in 2.9.x ended 14 November 2016 (18 months).
  • minimum PHP 5.4.4 (always use latest PHP 5.4.x or 5.5.x on Windows -, PHP 7 is NOT supported
  • /lib/
    FolderUp one level  
    Fileaccesslib.php             [source] [7556 lines]  This file contains functions for managing user access Public API vs internals
    Fileadminlib.php              [source] [9231 lines]  Functions and classes used during installation, upgrades and for admin settings. ADMIN SETTINGS TREE INTRODUCTION
    Fileauthlib.php               [source] [786 lines]   Multiple plugin authentication Support library 2006-08-28 File created, AUTH return values defined.
    Filebadgeslib.php             [source] [1234 lines]  Contains classes, functions and constants used in badges.
    Fileblocklib.php              [source] [2227 lines]  Block Class and Functions This file defines the {@link block_manager} class,
    Fileboxlib.php                [source] [913 lines] client.
    Fileclilib.php                [source] [178 lines]   Command line utility functions and classes
    Filecompletionlib.php         [source] [1332 lines]  Contains classes, functions and constants used during the tracking of activity completion for users. Completion top-level options (admin setting enablecompletion)
    Filecomponentlib.class.php    [source] [824 lines]   This library includes all the necessary stuff to use the one-click download and install feature of Moodle, used to keep updated some items like languages, pear, enviroment... i.e, components. It has been developed harcoding some important limits that are explained below: - It only can check, download and install items under moodledata. - Every downloadeable item must be one zip file. - The zip file root content must be 1 directory, i.e, everything is stored under 1 directory. - Zip file name and root directory must have the same name (but the .zip extension, of course). - Every .zip file must be defined in one .md5 file that will be stored in the same remote directory than the .zip file. - The name of such .md5 file is free, although it's recommended to use the same name than the .zip (that's the default assumption if no specified). - Every remote .md5 file will be a comma separated (CVS) file where each line will follow this format: - Field 1: name of the zip file (without extension). Mandatory. - Field 2: md5 of the zip file. Mandatory. - Field 3: whatever you want (or need). Optional. -Every local .md5 file will: - Have the zip file name (without the extension) plus -md5 - Will reside inside the expanded zip file dir - Will contain the md5 od the latest installed component With all these details present, the process will perform this tasks: - Perform security checks. Only admins are allowed to use this for now. - Read the .md5 file from source (1). - Extract the correct line for the .zip being requested. - Compare it with the local .md5 file (2). - If different: - Download the newer .zip file from source. - Calculate its md5 (3). - Compare (1) and (3). - If equal: - Delete old directory. - Uunzip the newer .zip file. - Create the new local .md5 file. - Delete the .zip file. - If different: - ERROR. Old package won't be modified. We shouldn't reach here ever. - If component download is not possible, a message text about how to do the process manually (remotedownloaderror) must be displayed to explain it.
    Fileconditionlib.php          [source] [29 lines]    DO NOT INCLUDE THIS FILE.
    Fileconfigonlylib.php         [source] [213 lines]   Minimalistic library, usable even when no other moodle libs are loaded. The only library that gets loaded if you define ABORT_AFTER_CONFIG before including main config.php. You can resume normal script operation if you define ABORT_AFTER_CONFIG_CANCEL and require the setup.php
    Filecoursecatlib.php          [source] [3078 lines]  Contains class coursecat reponsible for course category operations
    Filecronlib.php               [source] [295 lines]   Cron functions.
    Filecsslib.php                [source] [4998 lines]  This file contains CSS related class, and function for the CSS optimiser. Please see the {@link css_optimiser} class for greater detail.
    Filecsvlib.class.php          [source] [558 lines]   This is a one-line short description of the file You can have a rather longer description of the file as well, if you like, and it can span multiple lines.
    Filecustomcheckslib.php       [source] [37 lines]    This is a place to put custom environment checks, if there is not a better place.
    Filedatalib.php               [source] [1995 lines]  Library of functions for database manipulation. Other main libraries: - weblib.php - functions that produce web output - moodlelib.php - general-purpose Moodle functions
    Fileddllib.php                [source] [149 lines]   This library includes all the required functions used to handle the DB structure (DDL) independently of the underlying RDBMS in use. This library includes all the required functions used to handle the DB structure (DDL) independently of the underlying RDBMS in use. All the functions rely on the XMLDBDriver classes to be able to generate the correct SQL syntax needed by each DB.
    Filedeprecatedlib.php         [source] [4348 lines]  deprecatedlib.php - Old functions retained only for backward compatibility Old functions retained only for backward compatibility. New code should not use any of these functions.
    Filedmllib.php                [source] [380 lines]   This library contains all the Data Manipulation Language (DML) functions used to interact with the DB This library contains all the Data Manipulation Language (DML) functions used to interact with the DB. All the dunctions in this library must be generic and work against the major number of RDBMS possible. This is the list of currently supported and tested DBs: mysql, postresql, mssql, oracle
    Filedtllib.php                [source] [74 lines]    DTL == Database Transfer Library This library includes all the required functions used to handle transfer of data from one database to another.
    Fileeditorlib.php             [source] [241 lines]   Utility classes and functions for text editor integration.
    Fileemptyfile.php             [source] [21 lines]    This is an empty file. For those times when you want something you can request to get an empty response.
    Fileenrollib.php              [source] [2349 lines]  This library includes the basic parts of enrol api. It is available on each page.
    Fileenvironmentlib.php        [source] [1585 lines]  This library includes all the necessary stuff to execute some standard tests of required versions and libraries to run Moodle. It can be used from the admin interface, and both at install and upgrade. All the info is stored in the admin/environment.xml file, supporting to have an updated version in dataroot/environment
    Fileeventslib.php             [source] [617 lines]   Library of functions for events manipulation. The public API is all at the end of this file.
    Fileexcellib.class.php        [source] [858 lines]   Excel writer abstraction layer.
    Fileexternallib.php           [source] [944 lines]   Support for external API
    Filefilelib.php               [source] [4533 lines]  Functions for file handling.
    Filefilterlib.php             [source] [1499 lines]  Library functions for managing text filter plugins.
    Fileflickrlib.php             [source] [1163 lines]  phpFlickr Class 2.2.0 Written by Dan Coulter ( Sourceforge Project Page: {@link} Released under GNU Lesser General Public License ({@link}) For more information about the class and upcoming tools and toys using it, visit {@link} or {@link} For installation instructions, open the README.txt file packaged with this class. If you don't have a copy, you can see it at: {@link}
    Fileformslib.php              [source] [2971 lines]  formslib.php - library of classes for creating forms in Moodle, based on PEAR QuickForms. To use formslib then you will want to create a new file purpose_form.php eg. edit_form.php and you want to name your class something like {modulename}_{purpose}_form. Your class will extend moodleform overriding abstract classes definition and optionally defintion_after_data and validation.
    Filegdlib.php                 [source] [407 lines]   gdlib.php - Collection of routines in Moodle related to processing images using GD
    Filegoogleapi.php             [source] [451 lines]   Simple implementation of some Google API functions for Moodle.
    Filegradelib.php              [source] [1476 lines]  Library of functions for gradebook - both public and internal
    Filegraphlib.php              [source] [1787 lines]  Graph Class. PHP Class to draw line, point, bar, and area graphs, including numeric x-axis and double y-axis. Version: 1.6.3 Copyright (C) 2000 Herman Veluwenkamp This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.
    Filegrouplib.php              [source] [1099 lines]  
    Filehtml2text.php             [source] [750 lines]   
    Fileinstalllib.php            [source] [524 lines]   Functions to support installation process
    Filejavascript.php            [source] [109 lines]   This file is serving optimised JS
    Filejslib.php                 [source] [131 lines]   This file contains various javascript related functions, all functions here are self contained and can be used in ABORT_AFTER_CONFIG scripts.
    Fileldaplib.php               [source] [423 lines]   ldaplib.php - LDAP functions & data library Library file of miscellaneous general-purpose LDAP functions and data structures, useful for both ldap authentication (or ldap based authentication like CAS) and enrolment plugins.
    Filelexer.php                 [source] [413 lines]   PHP lexer code snarfed from the CVS tree for the lamplib project at This project is administered by Markus Baker, Harry Fuecks and Matt Mitchell, and the project code is in the public domain. Thanks, guys!
    Filelicenselib.php            [source] [219 lines]   A namespace contains license specific functions
    Filelistlib.php               [source] [627 lines]   Classes for displaying and editing a nested list of items. Handles functionality for :
    Filemathslib.php              [source] [136 lines]   
    Filemedialib.php              [source] [1276 lines]  Classes for handling embedded media (mainly audio and video). These are used only from within the core media renderer.
    Filemessagelib.php            [source] [580 lines]   Functions for interacting with the message system
    Filemodinfolib.php            [source] [2774 lines]  modinfolib.php - Functions/classes relating to cached information about module instances on a course.
    Filemoodlelib.php             [source] [9588 lines]  moodlelib.php - Moodle main library Main library file of miscellaneous general-purpose Moodle functions. Other main libraries: - weblib.php - functions that produce web output - datalib.php - functions that access the database
    Filemyprofilelib.php          [source] [435 lines]   Defines core nodes for my profile navigation tree.
    Filenavigationlib.php         [source] [5158 lines]  This file contains classes used to manage the navigation structures within Moodle.
    Fileoauthlib.php              [source] [663 lines]   
    Fileodslib.class.php          [source] [1511 lines]  ODS file writer. The xml used here is derived from output of LibreOffice 3.6.4 The design is based on Excel writer abstraction by Eloy Lafuente and others.
    Fileoutputactions.php         [source] [206 lines]   Classes representing JS event handlers, used by output components. Please see for an overview.
    Fileoutputcomponents.php      [source] [3760 lines]  Classes representing HTML elements, used by $OUTPUT methods Please see for an overview.
    Fileoutputfactories.php       [source] [447 lines]   Interface and classes for creating appropriate renderers for various parts of Moodle. Please see for an overview.
    Fileoutputlib.php             [source] [2106 lines]  Functions for generating the HTML that Moodle should output. Please see for an overview.
    Fileoutputrenderers.php       [source] [4723 lines]  Classes for rendering HTML output for Moodle. Please see {@link} for an overview.
    Fileoutputrequirementslib.php [source] [2039 lines]  Library functions to facilitate the use of JavaScript in Moodle. Note: you can find history of this file in lib/ajax/ajaxlib.php
    Filepagelib.php               [source] [1981 lines]  This file contains the moodle_page class. There is normally a single instance of this class in the $PAGE global variable. This class is a central repository of information about the page we are building up to send back to the user.
    Filepdflib.php                [source] [253 lines]   pdflib.php - Moodle PDF library We currently use the TCPDF library by Nicola Asuni.
    Fileplagiarismlib.php         [source] [204 lines]   plagiarismlib.php - Contains core Plagiarism related functions.
    Fileportfoliolib.php          [source] [1389 lines]  This file contains all global functions to do with manipulating portfolios. Everything else that is logically namespaced by class is in its own file in lib/portfolio/ directory.
    Filequestionlib.php           [source] [1941 lines]  Code for handling and processing questions This is code that is module independent, i.e., can be used by any module that uses questions, like quiz, lesson, .. This script also loads the questiontype classes Code for handling the editing of questions is in {@link question/editlib.php}
    Filerecaptchalib.php          [source] [325 lines]   This is a PHP library that handles calling reCAPTCHA. - Documentation and latest version {@link} - Get a reCAPTCHA API Key {@link} - Discussion group {@link} Copyright (c) 2007 reCAPTCHA -- {@link} AUTHORS: Mike Crawford Ben Maurer
    Filerequirejs.php             [source] [144 lines]   This file is serving optimised JS for RequireJS.
    Fileresourcelib.php           [source] [281 lines]   Recourse module like helper functions
    Filersslib.php                [source] [531 lines]   This file contains all the common stuff to be used in RSS System
    Filesearchlib.php             [source] [458 lines]   
    Filesessionkeepalive_ajax.php [source] [36 lines]    Ensure that session is kept alive.
    Filesessionlib.php            [source] [215 lines]   
    Filesetup.php                 [source] [1034 lines]  setup.php - Sets up sessions, connects to databases and so on Normally this is only called by the main config.php file Normally this file does not need to be edited.
    Filesetuplib.php              [source] [2038 lines]  These functions are required very early in the Moodle setup process, before any of the main libraries are loaded.
    Filesoaplib.php               [source] [150 lines]   Web services wrapper library script Since Moodle 2.0 we rely only on native PHP Soap extension, the original name of this file was lib/soap/phpsoap.php
    Filestatslib.php              [source] [1850 lines]  
    Filetablelib.php              [source] [1920 lines]  
    Filetokeniserlib.php          [source] [406 lines]   Based on Drupal's search.module version 1.224 {@link}
    Fileupgradelib.php            [source] [2368 lines]  Various upgrade/install related functions and classes.
    Fileuploadlib.php             [source] [116 lines]   uploadlib.php - This class handles all aspects of fileuploading
    Filevalidateurlsyntax.php     [source] [547 lines]   About validateUrlSyntax(): This function will verify if a http URL is formatted properly, returning either with true or false. I used rfc #2396 URI: Generic Syntax as my guide when creating the regular expression. For all the details see the comments below.
    Filewebdavlib.php             [source] [1734 lines]  
    Fileweblib.php                [source] [3604 lines]  Library of functions for web output Library of all general-purpose Moodle PHP functions and constants that produce HTML output
    Filewiki_to_markdown.php      [source] [393 lines]   Utility function to convert wiki-like to Markdown format
    Filewomenslib.php             [source] [29 lines]    
    Filexmlize.php                [source] [228 lines]   xmlize.php - xmlize() is by Hans Anderson, {@link} Ye Ole "Feel Free To Use it However" License [PHP, BSD, GPL]. some code in xml_depth is based on code written by other PHPers as well as one Perl script. Poor programming practice and organization on my part is to blame for the credit these people aren't receiving. None of the code was copyrighted, though.
    Filexsendfilelib.php          [source] [86 lines]    X-Sendfile support

    Search This Site: