Moodle Developer Resources

https://moodledev.io
Admin
Moodle Developer Resources provides guides, documentation, and community support for building,...
Tokens:204,577
Snippets:2,152
Trust Score:9.6
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install dependencies and start the application

Source: https://moodledev.io/general/app/development/development-guide

Commands to install required Node.js packages and launch the application in a browser.

```bash
npm install  

npm start  
```

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

### Example xmldb_block_example_install() function

Source: https://moodledev.io/docs/5.3/guides/upgrade

This is an example of an install.php script for a Moodle block plugin, demonstrating the use of the `xmldb_block_example_install()` function. This function is called when the plugin is first installed.

```php
<?php  

// ...  

  

function xmldb_block_example_install() {  

    // ...  

}  

```

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

### Calendar Event Cutoff Examples

Source: https://moodledev.io/docs/5.3/apis/core/calendar

Examples demonstrating how to return minimum and maximum cutoffs for calendar event start times, including error messages.

```json
[  
     [1505704373, 'The due date must be after the sbumission start date'], // Minimum cutoff.  
     [1506741172, 'The due date must be before the cutoff date'] // Maximum cutoff.  
]
```

```json
[null, null] // No limits.  
```

```json
[null, [1510625037, “This is the maximum cutoff”]] // No minimum cutoff.  
```

```json
[[1510625037, “This is the minimum cutoff”], null] // No maximum cutoff.  
```

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

### Example: Using Delegated Transactions

Source: https://moodledev.io/docs/5.3/apis/core/dml

Demonstrates a typical use case for delegated transactions, including starting, performing operations, allowing commit on success, and rolling back on exception.

```php
global $DB;

try {

     $transaction = $DB->start_delegated_transaction();

     $DB->insert_record('foo', $object);

     $DB->insert_record('bar', $otherobject);

  

     // Assuming the both inserts work, we get to the following line.

     $transaction->allow_commit();

  

} catch (Exception $e) {

     $transaction->rollback($e);

}
```

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

### Dispatching a Hook During Plugin Installation

Source: https://moodledev.io/docs/5.3/apis/core/hooks

Dispatch a custom hook after the plugin's XMLDB installation process is complete. This example shows how to instantiate the `installation_finished` hook and dispatch it using the core hook manager.

```php
<?php  
function xmldb_activity_install() {  

    $hook = new \mod_activity\hook\installation_finished();  

    \core\di::get(\core\hook\manager::class)->dispatch($hook);  

}  

  

```

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

### Correct namespace usage examples

Source: https://moodledev.io/general/development/policies/codingstyle

Examples showing the correct implementation of namespaces for plugins and core subsystems.

```php
// A namespace for the `mod_forum` plugin.  

  

namespace mod_forum;

class example {  

}  

  

// A namespace for the `external` subsystem usage in the `mod_forum` plugin.  

namespace mod_forum\external;

class example {  

}  

  

// A namespace for the `core_user` core subsystem.  

namespace core_user;

class example {}  
```

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

### Example db/upgrade.php Structure

Source: https://moodledev.io/docs/5.3/guides/upgrade

This example demonstrates the basic structure of the db/upgrade.php file, showing how to define upgrade functions based on the old plugin version. It includes placeholders for upgrade logic and a return statement indicating success.

```php
<?php  

function xmldb_[plugintype]_[pluginname]_upgrade($oldversion): bool {  
    global $CFG, $DB;  

    $dbman = $DB->get_manager(); // Loads ddl manager and xmldb classes.  

    if ($oldversion < 2019031200) {  
        // Perform the upgrade from version 2019031200 to the next version.  
    }  

    if ($oldversion < 2019031201) {  
        // Perform the upgrade from version 2019031201 to the next version.  
    }  

    // Everything has succeeded to here. Return true.  
    return true;  
}  


```

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

### Test Default Datasource Functionality

Source: https://moodledev.io/docs/5.3/apis/core/reportbuilder

Tests the default setup of a datasource, ensuring it returns the expected number of rows and that the data is ordered and formatted correctly. This example demonstrates adding a category and course to Moodle to test course count functionality.

```php
    /**  
     * Test default datasource  
     */  
    public function test_datasource_default(): void {  
        $this->resetAfterTest();  
  
        $category = $this->getDataGenerator()->create_category(['name' => 'Zoo', 'idnumber' => 'Z01']);  
        $course = $this->getDataGenerator()->create_course(['category' => $category->id]);  
  
        /** @var core_reportbuilder_generator $generator */  
        $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder');  
        $report = $generator->create_report(['name' => 'My report', 'source' => categories::class, 'default' => 1]);  
  
        $content = $this->get_custom_report_content($report->get('id'));  
        $this->assertCount(2, $content);  
  
        // Default columns are name, idnumber, coursecount. Sorted by name ascending.  
        $this->assertEquals([  
            [get_string('defaultcategoryname'), '', 0],  
            [$category->get_formatted_name(), $category->idnumber, 1],  
        ], array_map('array_values', $content));  
    }  
```

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

### Correct namespace examples for test classes

Source: https://moodledev.io/general/development/policies/codingstyle

Examples demonstrating the correct namespace mapping between plugin classes and their corresponding test classes.

```php
// Plugin's own namespace when not using nested namespaces (typical)  

// Namespace location: mod/breakfast/classes/  

// Test location: mod/breakfast/tests/  

namespace mod_breakfast;  

  

// Plugin's own namespace when using nested namespaces  

// Namespace location: mod/breakfast/classes/local/  

// Test location: mod/breakfast/tests/local/  

namespace mod_breakfast\local;  

  

// Plugin's own namespace when using nested namespaces with further organisation  

// Namespace location: mod/breakfast/classes/local/utils/  

// Test location: mod/breakfast/tests/local/utils/  

namespace mod_breakfast\local\utils;  

  

// Plugin's namespace to implement core API  

// Namespace location: mod/breakfast/classes/event/  

// Test location: mod/breakfast/tests/event/  

namespace mod_breakfast\event;
```

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

### Example Hook Callback Method

Source: https://moodledev.io/docs/5.3/apis/core/hooks

Defines a static method within a class that will be registered as a hook callback. Includes checks for initial installation and plugin configuration.

```php
<?php  

namespace local_stuff\local;  

use \mod_activity\hook\installation_finished;  


class hook_callbacks {  

    public static function activity_installation_finished(installation_finished $hook): void {  

        if (during_initial_install()) {  

            return;  

        }  

        if (!get_config('local_stuff', 'version')) {  

            return;  

        }  

        // Do something...  

    }  

}  

```

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

### Get Default Condition Values

Source: https://moodledev.io/docs/5.3/apis/core/reportbuilder

Optionally defines the initial values for default conditions. This method overrides the default setup for specific conditions.

```php
/**  
 * Return the condition values that will be set for the report upon creation  
 *  
 * @return array  
 */  
public function get_default_condition_values(): array {  
    return [  
        'task_log:type_operator' => select::EQUAL_TO,  
        'task_log:type_value' => \core\task\database_logger::TYPE_SCHEDULED,  
    ];  
}  
```

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

### PHP init method configuration

Source: https://moodledev.io/general/app/development/plugins-development-guide

Example of a static init method returning templates, otherdata, and a JavaScript string.

```php
public static function my_init() {  

    return [  

        'templates' => [  

            [  

                'id' => 'greeting',  

                'html' => '<p>Hello!</p>',  

            ],  

        ],  

        'otherdata' => ['foo' => 'bar'],  

        'javascript' => "  

            var result = { lorem: 'ipsum' };  

  

            result;  

        ",  

    ];  

}  
```

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

### Define Documentation Example

Source: https://moodledev.io/general/development/policies/codingstyle

All defines must be documented with a comment block describing their purpose.

```php
/**  

 * PARAM_INT - integers only, use when expecting only numbers.  

 */  
define('PARAM_INT', 'int');  

  

/**  

 * PARAM_ALPHANUM - expected numbers and letters only.  

 */  
define('PARAM_ALPHANUM', 'alphanum');
```

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

### PHPDoc @since tag example

Source: https://moodledev.io/general/development/policies/codingstyle

Example of using the @since tag to document the Moodle version of introduction.

```php

  @since Moodle 2.1  


```

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

### Example: Comparing TEXT Columns

Source: https://moodledev.io/docs/5.3/apis/core/dml

Demonstrates using sql_compare_text for comparing TEXT columns with placeholders. This example shows how to query groups based on a TEXT description.

```php
$comparedescription = $DB->sql_compare_text('description');  
$comparedescriptionplaceholder = $DB->sql_compare_text(':description');  
$todogroups = $DB->get_records_sql(  
    "SELECT id FROM {group} WHERE {$comparedescription} = {$comparedescriptionplaceholder}",  

    [  

        'description' => 'TODO',  

    ]  
);  
```

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

### Example Implementation of [modname]_supports

Source: https://moodledev.io/docs/5.3/apis/plugintypes/mod

An example implementation of the `[modname]_supports` function, demonstrating how to return values for various features using a match expression. This includes features like group support, completion tracking, and module purpose.

```php
function [modname]_supports($feature) {

    return match ($feature) {

        FEATURE_GROUPS => true,

        FEATURE_GROUPINGS => true,

        FEATURE_MOD_INTRO => true,

        FEATURE_COMPLETION_TRACKS_VIEWS => true,

        FEATURE_GRADE_HAS_GRADE => true,

        FEATURE_BACKUP_MOODLE2 => true,

        FEATURE_SHOW_DESCRIPTION => true,

        FEATURE_MOD_PURPOSE => MOD_PURPOSE_COLLABORATION,

        default => null,

    };

}
```

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

### Generate Coverage Configuration (mod_forum example)

Source: https://moodledev.io/docs/5.3/guides/testing

Example coverage.php file for mod_forum, specifying folders and files to include and exclude for code coverage analysis. Paths are relative to the component root.

```php
return new class extends phpunit_coverage_info {  

    /** @var array The list of folders relative to the plugin root to include */  

    protected $includelistfolders = [  

        'classes',  

        'externallib.php',  

    ];  

  

    /** @var array The list of files relative to the plugin root to include */  

    protected $includelistfiles = [];  

  

    /** @var array The list of folders relative to the plugin root to exclude */  

    protected $excludelistfolders = [];  

  

    /** @var array The list of files relative to the plugin root to exclude */  

    protected $excludelistfiles = [];  

};  
```

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

### Install Git on Debian/Ubuntu

Source: https://moodledev.io/docs/5.3/guides/git

Use this command to install Git on Debian-based Linux distributions like Ubuntu.

```bash
sudo apt-get install git
```

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

### Install Git on MacOS using Homebrew

Source: https://moodledev.io/docs/5.3/guides/git

Install Git on MacOS using the Homebrew package manager.

```bash
brew install git
```

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

### Example: LIKE Search with Literal

Source: https://moodledev.io/docs/5.3/apis/core/dml

Demonstrates using sql_like to search for records where a field partially matches a hard-coded literal value. This example shows how to construct the WHERE clause dynamically.

```php
$likeidnumber = $DB->sql_like('idnumber', ':idnum');  
$DB->get_records_sql(  
    "SELECT id, fullname FROM {course} WHERE {$likeidnumber}",  

    [  

        'idnum' => 'DEMO-%',  

    ]  
);  
```

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

### Get Table Alias Example

Source: https://moodledev.io/docs/5.3/apis/core/reportbuilder

Demonstrates how to retrieve table aliases for use in SQL queries within entities. This ensures compatibility with report configurations that may alter default table aliases.

```php
$logalias = $this->get_table_alias('logstore_standard_log');  

$useralias = $this->get_table_alias('user');  

$fildname = "{$useralias}.lastname";  

$join = "JOIN {user} {$useralias} ON {$useralias}.id = {$logalias}.relateduser"  
```

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

### Setup admin page permissions

Source: https://moodledev.io/docs/5.3/apis/subsystems/output

Use admin_externalpage_setup to perform permission checks on admin pages.

```php
require_once(__DIR__ . '/../../config.php');  

require_once("{$CFG->libdir}/adminlib.php");  

admin_externalpage_setup('example');
```

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

### Core Report Builder Testcase Setup

Source: https://moodledev.io/docs/5.3/apis/core/reportbuilder

Includes necessary setup for testing Report Builder data sources using the `core_reportbuilder_testcase`. Ensures the testcase is loaded and provides a base for testing data source functionality.

```php
defined('MOODLE_INTERNAL') || die();  
  
global $CFG;  
require_once("{$CFG->dirroot}/reportbuilder/tests/helpers.php");  
  
/**  
 * Unit tests for course categories datasource  
 *  
 * @package     core_course  
 * @covers      \core_course\reportbuilder\datasource\categories  
 * @copyright   2023 Paul Holden <paulh@moodle.com>  
 * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later  
 */  
class categories_test extends core_reportbuilder_testcase {  
```

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

### Example Profiling Output Files

Source: https://moodledev.io/docs/5.3/guides/profiling

These are examples of cachegrind output files generated by Xdebug. The file names indicate the script that was profiled and a timestamp.

```text
cachegrind.out._moodle2_mod_forum_view_php.1289838411
cachegrind.out._moodle2_index_php.1289837892
```

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

### PHPDoc @package tag example

Source: https://moodledev.io/general/development/policies/codingstyle

Example of using the @package tag to define the Frankenstyle component name.

```php

  @package gradereport_xls  


```

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

### Declare Localisation Strings in db/mobile.php

Source: https://moodledev.io/general/app/development/plugins-development-guide

Example configuration for the local_hello plugin showing how to register plugin-specific and core strings.

```php
$addons = [  

    'local_hello' => [  

        'handlers' => [  

            // ...  

        ],  

        'lang' => [  

            ['hello', 'local_hello'],  

            ['cancel', 'moodle'],  

        ],  

    ],  

];
```

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

### PHPDoc @see tag example

Source: https://moodledev.io/general/development/policies/codingstyle

Example of using the @see tag to reference related elements.

```php

  @see some_other_function()  


```

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

### Example Valid Hook Names

Source: https://moodledev.io/docs/5.3/apis/core/hooks

Illustrates the naming conventions for hooks, including prefixes like 'before' and 'after', and subsystem placement.

```php
\core_course\hook\before_course_visibility_changed
\core_form\hook\before_form_validation
\core_form\hook\after_form_validation
\core\hook\navigation\before_render
```

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

### PHPDoc @deprecated and @todo tags example

Source: https://moodledev.io/general/development/policies/codingstyle

Example of documenting deprecated code with @deprecated, @todo, and @see tags.

```php
/**  
 * ...  
 * @deprecated since Moodle 2.0 MDL-12345 - please do not use this function any more.  
 * @todo MDL-22334 This will be deleted in Moodle 2.2.  
 * @see class_name::new_function()  
 */  


```

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

### Mod Plugin English Language File Example

Source: https://moodledev.io/docs/5.3/apis/plugintypes/mod

Provides a complete example of an English language file for a Mod plugin, including copyright and license headers.

```php
<?php  

// This file is part of Moodle - http://moodle.org/  

//  

// Moodle is free software: you can redistribute it and/or modify  

// it under the terms of the GNU General Public License as published by  

// the Free Software Foundation, either version 3 of the License, or  

// (at your option) any later version.  

//  

// Moodle is distributed in the hope that it will be useful,  

// but WITHOUT ANY WARRANTY; without even the implied warranty of  

// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the  

// GNU General Public License for more details.  

//  

// You should have received a copy of the GNU General Public License  

// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.  

  

/**  

 * Languages configuration for the mod_[modname] plugin.  

 *  

 * @package   mod_[modname]  

 * @copyright Year, You Name <your@email.address>  

 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later  

 */  

  

$string['pluginname'] = 'The name of your activity';  


```

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

### Build an admin tool page

Source: https://moodledev.io/docs/5.3/apis/subsystems/output

A complete example of setting up an admin tool page, including configuration, page properties, renderer initialization, and rendering content.

```php
<?php  

// Standard GPL and phpdocs  

require_once(__DIR__ . '/../../../config.php');  

require_once($CFG->libdir.'/adminlib.php');  

  

admin_externalpage_setup('tooldemo');  

  

// Set up the page.  

$title = get_string('pluginname', 'tool_demo');  

$pagetitle = $title;  

$url = new moodle_url("/admin/tool/demo/index.php");  

$PAGE->set_url($url);  

$PAGE->set_title($title);  

$PAGE->set_heading($title);  

  

$output = $PAGE->get_renderer('tool_demo');  

  

echo $output->header();  

echo $output->heading($pagetitle);  

  

$renderable = new \tool_demo\output\index_page('Some text');  

echo $output->render($renderable);  

  

echo $output->footer();
```

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

### PHPDoc @license Tag Example

Source: https://moodledev.io/general/development/policies/codingstyle

Shows the required format for the @license tag, which must be GPL v3+.

```text

  @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later  


```

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

### TODO Comment Example

Source: https://moodledev.io/general/development/policies/codingstyle

TODO comments must include an MDL tracker reference.

```php
// TODO MDL-12345 This works but is a bit of a hack and should be revised in future.
```

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

### Inline Comment Formatting Example

Source: https://moodledev.io/general/development/policies/codingstyle

Inline comments must use the // style, start with a capital letter or digit, and end with proper punctuation.

```php
function forum_get_ratings_mean($postid, $scale, $ratings = null) {  

    if (!$ratings) {  

  

        $ratings = [];     // Initialize the empty array.  

  

        $rates = $DB->get_records('forum_ratings', ['post' => $postid)];  

  

        // ... then process each rating in  

        // turn.  

        foreach ($rates as $rate) {  

            do_something_with($rate);  

        }  

  

        // Do we need to tidy up?  

        if (!empty($rates))  

            // 42 more things happen here!  

            finsh_up();  

        }
```

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

### PHP Example: Enrol a user using a manual enrolment plugin

Source: https://moodledev.io/docs/5.3/apis/subsystems/enrol

Shows how to retrieve a specific enrolment plugin instance (e.g., manual) and then use its enrol_user method to enrol a user. Requires fetching the enrolment instance record first.

```php
$instance = $DB->get_record('enrol', ['courseid' => $course->id, 'enrol' => 'manual']);  
$enrolplugin = enrol_get_plugin($instance->enrol);  
$enrolplugin->enrol_user($instance, $user->id, $role->id, $timestart, $timeend);  

```

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

### Create a repository instance

Source: https://moodledev.io/docs/5.3/guides/testing

Create a repository instance using the provided type, record, and options.

```php
$this->getDataGenerator()->create_repository($type, $record, $options);
```

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

### Incorrect Upgrade Notes Format

Source: https://moodledev.io/docs/5.3/apis/commonfiles

This example illustrates an incorrect format for upgrade.txt where multiple versions are listed in the section title, which is not allowed.

```text
== 4.1, 4.0.2 ==  

An API change to empower educators!  

```

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

### PHP Example: Get users able to submit an assignment

Source: https://moodledev.io/docs/5.3/apis/subsystems/enrol

Demonstrates using get_enrolled_users to find all users within a context who possess the 'mod/assign:submit' capability.

```php
$submissioncandidates = get_enrolled_users($modcontext, 'mod/assign:submit');  

```

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

### Instantiate and Get Full Course Module Information

Source: https://moodledev.io/docs/5.3/apis/core/conditionalactivities

Demonstrates how to create a `condition_info` object and retrieve all necessary course module information to determine availability conditions.

```php
$cm->id = $id;

$test = new condition_info($cm, CONDITION_MISSING_EVERYTHING);

$fullcm = $test->get_full_course_module();
```

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

### Get Record with Multiple Conditions

Source: https://moodledev.io/docs/5.3/apis/core/dml

Example of retrieving a user record based on multiple conditions (firstname and lastname) using an associative array. Conditions are combined with AND.

```php
$user = $DB->get_record('user', ['firstname'  => 'Martin', 'lastname'  => 'Dougiamas']);  

```

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

### Implement settings.php for local_helloworld plugin

Source: https://moodledev.io/docs/5.3/apis/subsystems/admin

This example demonstrates how a local plugin adds a configuration checkbox to the admin tree. It uses $hassiteconfig for permission checks and $ADMIN->fulltree to ensure settings are only added when necessary for performance.

```php
<?php  

// This file is part of Moodle - https://moodle.org/  

//  

// Moodle is free software: you can redistribute it and/or modify  

// it under the terms of the GNU General Public License as published by  

// the Free Software Foundation, either version 3 of the License, or  

// (at your option) any later version.  

//  

// Moodle is distributed in the hope that it will be useful,  

// but WITHOUT ANY WARRANTY; without even the implied warranty of  

// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the  

// GNU General Public License for more details.  

//  

// You should have received a copy of the GNU General Public License  

// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.  

  

/**  

 * Adds admin settings for the plugin.  

 *  

 * @package     local_helloworld  

 * @category    admin  

 * @copyright   2020 Your Name <email@example.com>  

 * @license     https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later  

 */  

  

defined('MOODLE_INTERNAL') || die();  

  

if ($hassiteconfig) {  

    $ADMIN->add('localplugins', new admin_category('local_helloworld_settings', new lang_string('pluginname', 'local_helloworld')));  

    $settingspage = new admin_settingpage('managelocalhelloworld', new lang_string('manage', 'local_helloworld'));  

  

    if ($ADMIN->fulltree) {  

        $settingspage->add(new admin_setting_configcheckbox(  

            'local_helloworld/showinnavigation',  

            new lang_string('showinnavigation', 'local_helloworld'),  

            new lang_string('showinnavigation_desc', 'local_helloworld'),  

            1  

        ));  

    }  

  

    $ADMIN->add('localplugins', $settingspage);  

}  
```

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

### Get Record with Named Placeholders

Source: https://moodledev.io/docs/5.3/apis/core/dml

Example of using named placeholders (:firstname, :lastname) in SQL queries for secure parameter binding. Parameters are provided in an associative array.

```php
$DB->get_record_sql(
    'SELECT * FROM {user} WHERE firstname = :firstname AND lastname = :lastname',
    [
        'firstname'  => 'Martin',
        'lastname'  => 'Dougiamas',
    ]
);

```

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

### Explicit Property Documentation

Source: https://moodledev.io/general/development/policies/codingstyle

Example showing that every property must be documented explicitly, even when sharing common characteristics.

```php
class zebra {  

    /** @var int The number of white stripes */  

    protected $whitestripes = 0;  

  

    /** @var int The number of black stripes */  

    protected $blackstripes = 0;  

  

    /** @var int The number of red stripes */  

    protected $redstripes = 0;  

}
```

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

### Get Record with Question Mark Placeholders

Source: https://moodledev.io/docs/5.3/apis/core/dml

Example of using question mark placeholders (?) in SQL queries for secure parameter binding. The parameters are provided in an indexed array.

```php
$DB->get_record_sql(
    'SELECT * FROM {user} WHERE firstname = ? AND lastname = ?',
    [
        'Martin',
        'Dougiamas',
    ]
);

```

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

### Set a Preference and Retrieve All

Source: https://moodledev.io/docs/5.3/apis/core/preference

Shows how to set a preference and then retrieve all user preferences, including the newly set one.

```php
set_user_preference('foo_showavatars', 'no');

// returns [
//     foo_nameformat  => "long",
//     foo_showavatars => "no",
// ];
get_user_preferences();
```

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

### Get Record Without Table Prefix

Source: https://moodledev.io/docs/5.3/apis/core/dml

Example of retrieving a record from the 'user' table without explicitly using the table prefix. The API handles prefixing automatically.

```php
$user = $DB->get_record('user', ['id' => '1']);  

```

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

### Get Record Using Custom SQL with Table Prefix

Source: https://moodledev.io/docs/5.3/apis/core/dml

Example of using custom SQL with table names enclosed in curly braces, which are automatically converted to prefixed table names.

```php
$user = $DB->get_record_sql('SELECT COUNT(*) FROM {user} WHERE deleted = 1 OR suspended = 1;');  

```

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

### Upgrade Notes for Moodle 4.0.2

Source: https://moodledev.io/docs/5.3/apis/commonfiles

This example demonstrates documenting changes for a specific patch version in the upgrade.txt file. This is used when changes are applied to stable branches.

```text
== 4.0.2 ==  

An API change to empower educators!  

```

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

### Correct namespaced class file structure

Source: https://moodledev.io/general/development/policies/codingstyle

Example of a correctly structured file using a single namespace declaration.

```php
<?php  

  

namespace mod_porridge\local\equipment;

  

class spoon {  

    // Your code here.  

}  
```

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

### Set Multiple Preferences and Retrieve All

Source: https://moodledev.io/docs/5.3/apis/core/preference

Illustrates setting an array of preferences and then retrieving all current preferences, including the updated and new ones.

```php
$preferences = [
    'foo_displaynum' => '100',

    'foo_nameformat' => 'short',

];

set_user_preferences($preferences);

// returns [
//     foo_nameformat  => "short",
//     foo_showavatars => "no",
//     foo_displaynum  => "100",
// ];
get_user_preferences();
```

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

### Get Tag Cloud for Collection

Source: https://moodledev.io/docs/5.3/apis/subsystems/tag

Retrieves all tags within a specific tag collection to display them, for example, as a tag cloud. This method is used to access tags managed by a custom tag area.

```php
tag_collection::get_tag_cloud()
```

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

### Example version.php for a Mod Plugin

Source: https://moodledev.io/docs/5.3/apis/plugintypes/mod

This snippet shows the structure and required metadata for a version.php file in a Moodle mod plugin. It includes version, requirements, compatibility, maturity, release, and dependency information. Ensure all TODO placeholders are replaced with actual values.

```php
<?php  

// This file is part of Moodle - http://moodle.org/  

//  

// Moodle is free software: you can redistribute it and/or modify  
// it under the terms of the GNU General Public License as published by  
// the Free Software Foundation, either version 3 of the License, or  
// (at your option) any later version.  

// Moodle is distributed in the hope that it will be useful,  
// but WITHOUT ANY WARRANTY; without even the implied warranty of  
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the  
// GNU General Public License for more details.  

// You should have received a copy of the GNU General Public License  
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.  

/**  
 * Version metadata for the mod_[modname] plugin.  
 *  
 * @package   mod_[modname]  
 * @copyright Year, You Name <your@email.address>  
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later  
 */  

defined('MOODLE_INTERNAL') || die();  

$plugin->version = TODO;  
$plugin->requires = TODO;  
$plugin->supported = TODO;   // Available as of Moodle 3.9.0 or later.  
$plugin->incompatible = TODO;   // Available as of Moodle 3.9.0 or later.  
$plugin->component = 'TODO_FRANKENSTYLE';  
$plugin->maturity = MATURITY_STABLE;  
$plugin->release = 'TODO';  

$plugin->dependencies = [
    'mod_forum' => 2022042100,
    'mod_data' => 2022042100
];  

```

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

### Get Moodle Plugin Types

Source: https://moodledev.io/docs/5.3/apis/plugintypes

This script retrieves and displays a list of all plugin types known to your Moodle installation, along with their plural names and directory paths. It requires Moodle's configuration to be loaded.

```php
<?php  

define('CLI_SCRIPT', true);  

require('config.php');  

  

$pluginman = core_plugin_manager::instance();  

  

foreach ($pluginman->get_plugin_types() as $type => $dir) {  

    $dir = substr($dir, strlen($CFG->dirroot));  

    printf(  

        "%-20s %-50s %s" . PHP_EOL,  

        $type,  

        $pluginman->plugintype_name_plural($type),  

        $dir)  

    ;  

}  

  


```

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

### Example db/upgrade.php for Plugin Upgrade

Source: https://moodledev.io/docs/5.3/apis/plugintypes/mod

This snippet demonstrates how to define database schema changes and other upgrade steps within the db/upgrade.php file. It includes adding new fields to existing tables and setting savepoints for the upgrade process. Ensure that the XMLDB editor is used to generate these steps.

```php
<?php  

// This file is part of Moodle - http://moodle.org/  

//  

// Moodle is free software: you can redistribute it and/or modify  
// it under the terms of the GNU General Public License as published by  
// the Free Software Foundation, either version 3 of the License, or  
// (at your option) any later version.  

// Moodle is distributed in the hope that it will be useful,  
// but WITHOUT ANY WARRANTY; without even the implied warranty of  
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the  
// GNU General Public License for more details.  

// You should have received a copy of the GNU General Public License  
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.  

/**  
 * Upgrade steps for the mod_[modname] plugin.  
 *  
 * @package   mod_[modname]  
 * @copyright Year, You Name <your@email.address>  
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later  
 */  

function xmldb_certificate_upgrade($oldversion = 0) {  

    if ($oldversion < 2012091800) {  

        // Add new fields to certificate table.  

        $table = new xmldb_table('certificate');  

        $field = new xmldb_field('showcode');  

        $field->set_attributes(XMLDB_TYPE_INTEGER, '1', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0', 'savecert');  

        if (!$dbman->field_exists($table, $field)) {  

            $dbman->add_field($table, $field);  

        }  

        // Add new fields to certificate_issues table.  

        $table = new xmldb_table('certificate_issues');  

        $field = new xmldb_field('code');  

        $field->set_attributes(XMLDB_TYPE_CHAR, '50', null, null, null, null, 'certificateid');  

        if (!$dbman->field_exists($table, $field)) {  

            $dbman->add_field($table, $field);  

        }  

  

        // Certificate savepoint reached.  

        upgrade_mod_savepoint(true, 2012091800, 'certificate');  

    }  

  

    // Everything has succeeded to here. Return true.  

    return true;  

}  

```

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

### Minimalistic Restore Task Class for Admin Tools

Source: https://moodledev.io/docs/5.3/apis/subsystems/backup/restore

This is a basic example of a restore task class for an admin tool plugin. It extends the restore_tool_plugin class and defines the structure for restoring plugin data. Use this as a starting point for implementing your plugin's restore functionality.

```php
require_once($CFG->dirroot . '/backup/moodle2/restore_tool_plugin.class.php');  

  
  class restore_tool_foobar_plugin extends restore_tool_plugin {  
  
  
    protected function define_course_plugin_structure() {  
  
        $paths = array();  
  
        $this->step->log('Yay, restore!', backup::LOG_DEBUG);  
  
        return $paths;  
  
    }  
  
}
```

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

### Incorrect Commenting Examples

Source: https://moodledev.io/general/development/policies/codingstyle

Examples of incorrect commenting styles that should be avoided.

```php
/*  Comment explaining this piece of code. */  

# Comment explaining this piece of code.  

// comment explaining this piece of code (without capital letter and punctuation)
```

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

### Single-line Comment Example

Source: https://moodledev.io/general/development/policies/codingstyle

Example of correct single-line comment styling.

```php
// Comment explaining this piece of code.
```

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

### Build and launch native app with npm

Source: https://moodledev.io/general/app/development/development-guide

Use these npm scripts to build and launch the Moodle App for Android or iOS development environments.

```bash
npm run dev:android
```

```bash
npm run dev:ios
```

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

### PHPDoc @category tag example

Source: https://moodledev.io/general/development/policies/codingstyle

Example of using the @category tag for Core APIs.

```php

  @category preferences  


```

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

### Example: LIKE Search with User Input

Source: https://moodledev.io/docs/5.3/apis/core/dml

Shows how to perform a partial LIKE comparison using user-submitted input. It combines sql_like_escape with sql_like to safely incorporate user search terms.

```php
$search = required_param('search', PARAM_RAW);  

$likefullname = $DB->sql_like('fullname', ':fullname');  
$DB->get_records_sql(  
    "SELECT id, fullname FROM {course} WHERE {$likefullname}",  

    [  

        'fullname'  => '%' . $DB->sql_like_escape($search) . '%',  

    ]  
);  
```

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

### visually_hidden_text() output example

Source: https://moodledev.io/docs/5.3/apis/subsystems/output

Example of the HTML output generated by visually_hidden_text in the Boost theme.

```html
<span class="visually-hidden">Contents</span>
```

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

### Create File from Disk Path

Source: https://moodledev.io/docs/5.3/apis/subsystems/files

Creates a Moodle file from an existing file on disk. Requires a fileinfo record and the path to the source file.

```php
$fs = get_file_storage();  
// Create a new file containing the text 'hello world'.  
$fs->create_file_from_pathname($fileinfo, $requestdir . '/helloworld.txt');  

```

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

### PHPDoc @link tag example

Source: https://moodledev.io/general/development/policies/codingstyle

Example of using the @link tag to reference an external URL.

```php

  @link https://docs.moodle.org/dev/Core_APIs  


```

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

### Incorrect namespace usage examples

Source: https://moodledev.io/general/development/policies/codingstyle

Examples of deprecated class naming patterns that should be avoided in new code.

```php
// Namespaced classes are no longer allowed for new code, except where it is unavoidable.  

class mod_forum_example {  

}  

  

class mod_forum_external_example {  

}  

  

class core_user_example {  

}  
```

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

### Set up a basic text editor

Source: https://moodledev.io/docs/5.3/apis/subsystems/editor

Use this snippet to initialize a preferred text editor for a given HTML text area ID. It retrieves the editor instance and then enables it for the specified element.

```php
$editor = editors_get_preferred_editor(FORMAT_HTML);

$editor->use_editor('mytextareaid');  

```

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

### Basic Lock Usage Example

Source: https://moodledev.io/docs/5.3/apis/core/lock

Demonstrates how to acquire, use, and release a lock for a specific resource. Ensure locks are always released, even on failure. The lock type must be prefixed with the component name.

```php
$timeout = 5;

// A namespace for the locks. Must be prefixed with the component name to prevent conflicts.
$locktype = 'mod_assign_download_submissions';

// Resource key - needs to uniquely identify the resource that is to be locked. E.g. If you
// want to prevent a user from running multiple course backups - include the userid in the key.
$resource = 'user:' . $USER->id;

// Get an instance of the currently configured lock_factory.
$lockfactory = \core\lock\lock_config::get_lock_factory($locktype);

// Get a new lock for the resource, wait for it if needed.
if ($lock = $lockfactory->get_lock($resource, $timeout)) {
    // We have exclusive access to the resource, do the slow zip file generation...

    if ($someerror) {
        // Always release locks on failure.
        $lock->release();
        print_error('blah');
    }

    // Release the lock once finished.
    $lock->release();

} else {
    // We did not get access to the resource in time, give up.
    throw new moodle_exception('locktimeout');
}

```

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

### Correct variable naming examples

Source: https://moodledev.io/general/development/policies/codingstyle

Examples of properly formatted, lower-case, meaningful variable names in PHP.

```php
$quiz = null;  

$errorstring = null;  

$assignments = null; // For an array of objects.  

$i = null; // Only in little loops.  

$allowfilelocking = false;  
```

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

### Create a Report Column

Source: https://moodledev.io/docs/5.3/apis/core/reportbuilder

Example demonstrating how to create a new report column instance, set its type, add joins, define fields, and specify sortability. Use this when defining custom columns for reports.

```php
$columns[] = (new column(
            'starttime',
            new lang_string('task_starttime', 'admin'),
            $this->get_entity_name()
        ))
            ->add_joins($this->get_joins())
            ->set_type(column::TYPE_TIMESTAMP)
            ->add_field("{$tablealias}.timestart")
            ->set_is_sortable(true)
            ->add_callback([format::class, 'userdate']);

```

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

### PHPDoc inline @link tag example

Source: https://moodledev.io/general/development/policies/codingstyle

Example of using the @link tag inline within a PHPDoc comment.

```php
   /**  
    * For details about the implementation below, visit {@link https://docs.moodle.org/dev/Core_APIs} and read...  
    * .....  


```

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

### Create a repository type

Source: https://moodledev.io/docs/5.3/guides/testing

Create a repository type using the provided type, record, and options.

```php
$this->getDataGenerator()->create_repository_type($type, $record, $options);
```

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

### PHPDoc inline @see tag example

Source: https://moodledev.io/general/development/policies/codingstyle

Example of using the @see tag inline within a PHPDoc comment.

```php
   /**  
    * This function uses {@see get_string()} to obtain the currency names...  
    * .....  


```

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

### Start Delegated Transaction

Source: https://moodledev.io/docs/5.3/apis/core/dml

Starts a delegated transaction. This is the first step in managing transactional operations within the DML.

```php
global $DB;

$transaction = $DB->start_delegated_transaction();
```

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

### Create Calendar Event

Source: https://moodledev.io/docs/5.3/apis/core/calendar

Example of how to instantiate and set properties for a new calendar event. Different properties are set for site, category, course, and user events.

```php
$event->component = 'tool_yourtool';  

$event->modulename = '';  

$event->eventtype = 'myeventtype';  

$event->instance = $instanceid; // Whatever instance you want.  

$event->type = CALENDAR_EVENT_TYPE_STANDARD; // Or: $event->type = CALENDAR_EVENT_TYPE_ACTION;  

// ... Other properties, see section "Create event" above.  

// For site events:  
$event->courseid = SITEID;  
$event->categoryid = 0;  

// For category events:  
$event->categoryid = $categoryid;  
$event->courseid = 0;  

// For course events:  
$event->courseid = $courseid;  
$event->categoryid = 0;  

// For user events:  
$event->courseid = 0;  
$event->categoryid = 0;  
$event->userid = $userid;  
```

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

### Get All Courses

Source: https://moodledev.io/docs/5.3/apis/core/dml

Retrieves all current courses in Moodle. Use this function without parameters to get a list of all courses.

```php
$courses = get_courses();  

```

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

### Context Fetching

Source: https://moodledev.io/docs/5.3/apis/subsystems/access

Demonstrates how to instantiate context objects for various Moodle entities like system, user, course category, course, module, and block. It also shows how to fetch a context by its ID.

```APIDOC
## Context Fetching

### Fetching by object id

```php
$systemcontext = context_system::instance();
$usercontext = context_user::instance($user->id);
$categorycontext = context_coursecat::instance($category->id);
$coursecontext = context_course::instance($course->id);
$contextmodule = context_module::instance($cm->id);
$contextblock = context_block::instance($this->instance->id);
```

### Fetching by context id

```php
$context = context::instance_by_id($contextid);
```

**Notes:**
* By default, an exception is thrown if the context cannot be created.
* Deleted users no longer have contexts.
```

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

### Incorrect namespace examples for test classes

Source: https://moodledev.io/general/development/policies/codingstyle

Examples of namespace declarations that violate the established component and API naming rules.

```php
namespace mymodule;                     // Violates the level1 rules - invalid component name  

namespace mod_breakfast\myutilities;    // Violates the level2 rules - invalid core API name  

namespace mod_forum\test;               // While technically correct ("test" is a valid API) - it's not ok  

                                        // because the namespace in tests should match the namespace of the code  

                                        // being covered, and normally components don't have any "test"  

                                        // level-2 to be covered. Only then it could be used.
```

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

### Create a group with details

Source: https://moodledev.io/docs/5.3/guides/testing

Create a group by providing specific details such as name, description, and description format.

```php
$this->getDataGenerator()->create_group([
    'courseid' => $courseid,
    'name' => $name,
    'description' => $description,
    'descriptionformat' => $descriptionformat,
]);
```

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

### Clone Moodle GitHub Repository

Source: https://moodledev.io/docs/5.3/guides/git

Use this command to create a local clone of your GitHub repository. It initializes a new Git repository and sets up the remote origin.

```bash
git clone git@github.com:YOUR_GITHUB_USERNAME/moodle.git
```

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

### Incorrect variable naming examples

Source: https://moodledev.io/general/development/policies/codingstyle

Examples of variable naming patterns that violate Moodle coding standards, such as camelCase or negative naming.

```php
$Quiz = null; // Variables should be all lower case.  

$camelCase = null; // Variables should not be in camelCase, PascalCase.  

$aReallyLongVariableNameWithoutAGoodReason = null; // Variable names should be sensible and short.  

$error_string = null; // Variable names should not contain underscores.  

$preventfilelocking = true; // Variable names should not be negative.  
```

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

### Create a User

Source: https://moodledev.io/docs/5.3/guides/testing

Create a new user account for testing. You can specify user properties like email and username.

```php
$user = $this->getDataGenerator()->create_user();
```

```php
$user1 = $this->getDataGenerator()->create_user([
    'email' => 'user1@example.com',
    'username' => 'user1',
]);
```

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

### Define local_hello plugin mobile handlers

Source: https://moodledev.io/general/app/development/plugins-development-guide

Create the db/mobile.php file to register the plugin handler with the CoreMainMenuDelegate.

```php
<?php  
  
defined('MOODLE_INTERNAL') || die();  
  
$addons = [  
    'local_hello' => [  
        'handlers' => [  
            'hello' => [  
                'delegate' => 'CoreMainMenuDelegate',  
                'method' => 'view_hello',  
                'displaydata' => [  
                    'title' => 'hello',  
                    'icon' => 'earth',  
                ],  
            ],  
        ],  
        'lang' => [  
            ['hello', 'local_hello'],  
        ],  
    ],  
];
```

```php
<?php  
  
namespace local_hello\output;  
  
defined('MOODLE_INTERNAL') || die();  
  
class mobile {  
  
    public static function view_hello() {  
        return [  
            'templates' => [  
                [  
                    'id' => 'main',  
                    'html' => '<h1 class="text-center">{{ "plugin.local_hello.hello" | translate }}</h1>',  
                ],  
            ],  
        ];  
    }  
  
}
```

```php
<?php  
  
$string['hello'] = 'Hello World';  
$string['plugin_name'] = 'Hello';
```

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

### Example: Including Favourites in an External Course Query

Source: https://moodledev.io/docs/5.3/apis/subsystems/favourites

Demonstrates how to modify an existing SQL query to include favourite information using the get_join_sql_by_type method. This preserves the original record set.

```php
$sql = "SELECT c.id, c.name  
          FROM {course} c  
         WHERE c.category = :category";
$params = ['category' => 3];  

$courses = $DB->get_records_sql($sql, $params);
```

```php
$ufservice = \core_favourites\service_factory::get_service_for_user_context($usercontext);  
list($favsql, $favparams) = $ufservice->get_join_sql_by_type('core_course', 'courses', 'favalias', 'c.id');  

$sql = "SELECT c.id, c.name, favalias.id as favouriteid  
          FROM {course} c  
       $favsql  
         WHERE c.category = :category";
$params = ['category' => 3] + $favparams;  

$courses = $DB->get_records_sql($sql, $params);
```

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

### Discovering Hooks with a Discovery Agent

Source: https://moodledev.io/docs/5.3/apis/core/hooks

Implement the `core\hook\discovery_agent` interface to define custom hook discovery for components not in standard locations. This example shows how to register a hook for when an example entity is created.

```php
<?php  

namespace mod_example;  

class hooks implements \core\hook\discovery_agent {  
    public static function discover_hooks(): array {  
        return [  
            [  
                'class' => \mod_example\local\entitychanges\create_example::class,  
                'description' => 'A hook fired when an example was created',  
            ],  
        ];  
    }  

}  

```

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

### Upgrade Notes for Moodle 4.1

Source: https://moodledev.io/docs/5.3/apis/commonfiles

This example shows how to document API changes for a specific Moodle version in the upgrade.txt file. The section title indicates the Moodle version where the change was introduced.

```text
== 4.1 ==  

An API change to empower educators!  

```

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

### Example AMD JavaScript Module

Source: https://moodledev.io/docs/5.3/apis/commonfiles

This is an example of an AMD JavaScript module used in Moodle. It demonstrates importing functions and exporting module functionality. Ensure you follow Moodle's JavaScript coding standards.

```javascript
// This file is part of Moodle - http://moodle.org/  

//  

// Moodle is free software: you can redistribute it and/or modify  
// it under the terms of the GNU General Public License as published by  
// the Free Software Foundation, either version 3 of the License, or  
// (at your option) any later version.  

// Moodle is distributed in the hope that it will be useful,  
// but WITHOUT ANY WARRANTY; without even the implied warranty of  
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the  
// GNU General Public License for more details.  

// You should have received a copy of the GNU General Public License  
// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.  
  
/**  
 * Example module for the plugintype_pluginname plugin.  
 *  
 * @module   plugintype_pluginname/example  
 * @copyright Year, You Name <your@email.address>  
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later  
 */  
  
import {fetchThings} from './repository';  
  
export const updateThings = (thingData) => {  
    return fetchThings(thingData);  
};  

```

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

### PHPDoc @return Tag Example

Source: https://moodledev.io/general/development/policies/codingstyle

Shows the correct format for the @return tag.

```text

  @return [[#Types|type]] Description.  


```
Tokens:
Raw