module.delete

Description

object module.delete(array moduleids)

This method allows to uninstall modules.

This method is only available to Super admin user type. Permissions to call the method can be revoked in user role settings. See User roles for more information.

Module files must be removed manually.

Parameters

(array) IDs of the modules to uninstall.

Return values

(object) Returns an object containing the IDs of the uninstalled modules under the moduleids property.

Exemplos

Uninstalling multiple modules

Uninstall modules "27" and "28".

Request:

{
           "jsonrpc": "2.0",
           "method": "module.delete",
           "params": [
               "27",
               "28"
           ],
           "id": 1
       }
Copy
✔ Copied

Response:

{
           "jsonrpc": "2.0",
           "result": {
               "moduleids": [
                   "27",
                   "28"
               ]
           },
           "id": 1
       }
Copy
✔ Copied

Source

CModule::delete() in ui/include/classes/api/services/CModule.php.

To toggle search highlight, press Ctrl+Alt+H
Have an improvement suggestion for this page? Select the text that could be improved and press Ctrl+Enter to send it to the editors.