Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
core_blog\external Class Reference

This is the external API for blogs. More...

Inheritance diagram for core_blog\external:

Static Public Member Functions

static get_entries ($filters=array(), $page=0, $perpage=10)
 Return blog entries.
 
static get_entries_parameters ()
 Returns description of get_entries() parameters.
 
static get_entries_returns ()
 Returns description of get_entries() result value.
 
static view_entries ($filters=array())
 Trigger the blog_entries_viewed event.
 
static view_entries_parameters ()
 Returns description of view_entries() parameters.
 
static view_entries_returns ()
 Returns description of view_entries() result value.
 

Static Protected Member Functions

static validate_access_and_filters ($rawwsfilters)
 Validate access to the blog and the filters to apply when listing entries.
 

Detailed Description

This is the external API for blogs.

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

Member Function Documentation

◆ get_entries()

static core_blog\external::get_entries ( $filters = array(),
$page = 0,
$perpage = 10 )
static

Return blog entries.

Parameters
array$filtersthe parameters to filter the blog listing
int$pagethe blog page to return
int$perpagethe number of posts to return per page
Return values
arraywith the blog entries and warnings
Since
Moodle 3.6

◆ get_entries_parameters()

static core_blog\external::get_entries_parameters ( )
static

Returns description of get_entries() parameters.

Return values
external_function_parameters
Since
Moodle 3.6

◆ get_entries_returns()

static core_blog\external::get_entries_returns ( )
static

Returns description of get_entries() result value.

Return values
core_external\external_description
Since
Moodle 3.6

◆ validate_access_and_filters()

static core_blog\external::validate_access_and_filters ( $rawwsfilters)
staticprotected

Validate access to the blog and the filters to apply when listing entries.

Parameters
array$rawwsfiltersarray containing the filters in WS format
Return values
arraycontext, filters to apply and the calculated courseid and user
Since
Moodle 3.6

◆ view_entries()

static core_blog\external::view_entries ( $filters = array())
static

Trigger the blog_entries_viewed event.

Parameters
array$filtersthe parameters used in the filter of get_entries
Return values
arraywith status result and warnings
Since
Moodle 3.6

◆ view_entries_parameters()

static core_blog\external::view_entries_parameters ( )
static

Returns description of view_entries() parameters.

Return values
external_function_parameters
Since
Moodle 3.6

◆ view_entries_returns()

static core_blog\external::view_entries_returns ( )
static

Returns description of view_entries() result value.

Return values
core_external\external_description
Since
Moodle 3.6

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