PHP WHMCS DeactivateModule用法及代码示例

停用给定的模块。

请求参数

参数	类型	说明	必需的
action	string	“DeactivateModule”	Required
moduleType	string	要停用的模块类型	Required
moduleName	string	要停用的模块名称	Required
newGateway	string	停用网关模块时将各个实体切换到的网关。	Optional

响应参数

参数	类型	说明
result	string	操作结果：成功或错误

示例请求 (CURL)

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://www.example.com/includes/api.php');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS,
    http_build_query(
        array(
            'action' => 'DeactivateModule',
            // See https://developers.whmcs.com/api/authentication
            'username' => 'IDENTIFIER_OR_ADMIN_USERNAME',
            'password' => 'SECRET_OR_HASHED_PASSWORD',
            'moduleType' => 'gateway',
            'moduleName' => 'paypal',
            'responsetype' => 'json',
        )
    )
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);

示例请求(本地 API)

$command = 'DeactivateModule';
$postData = array(
    'moduleType' => 'gateway',
    'moduleName' => 'paypal',
);
$adminUsername = 'ADMIN_USERNAME'; // Optional for WHMCS 7.2 and later

$results = localAPI($command, $postData, $adminUsername);
print_r($results);

示例响应 JSON

{
    "result": "success"
}

错误响应

可能的错误条件响应包括：

• 提供的模块类型无效。支持的模块类型包括：xxx
• 提供的模块名称无效。
• 模块类型不支持模块停用。
• 停用失败：xxx
• 发生意外错误：xxx