Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
mod_label_external Class Reference

Label external functions. More...

Inheritance diagram for mod_label_external:

Static Public Member Functions

static get_labels_by_courses ($courseids=array())
 Returns a list of labels in a provided list of courses.
 
static get_labels_by_courses_parameters ()
 Describes the parameters for get_labels_by_courses.
 
static get_labels_by_courses_returns ()
 Describes the get_labels_by_courses return value.
 

Detailed Description

Label external functions.

License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
Since
Moodle 3.3

Member Function Documentation

◆ get_labels_by_courses()

static mod_label_external::get_labels_by_courses ( $courseids = array())
static

Returns a list of labels in a provided list of courses.

If no list is provided all labels that the user can view will be returned.

Parameters
array$courseidscourse ids
Return values
arrayof warnings and labels
Since
Moodle 3.3

◆ get_labels_by_courses_parameters()

static mod_label_external::get_labels_by_courses_parameters ( )
static

Describes the parameters for get_labels_by_courses.

Return values
external_function_parameters
Since
Moodle 3.3

◆ get_labels_by_courses_returns()

static mod_label_external::get_labels_by_courses_returns ( )
static

Describes the get_labels_by_courses return value.

Return values
external_single_structure
Since
Moodle 3.3

The documentation for this class was generated from the following file: