Question Add Location entry into NGINX Conf

[JaXnPriVate]

Server operating system version

Ubuntu

Plesk version and microupdate number

-

I have seen that you can get the WebServer Object.

The only question is, what does this do for me, all variables are protected and it was nowhere described what the getParameter method does.

Web Server

Using Plesk SDK API, an extension can make changes to the web server configuration. Class pm_Hook_WebServer allows t...

docs.plesk.com

 

[abashurov]

Hi! In case you'd like to add some sort of the custom configuration, you need to implement a corresponding hook and its methods, e.g.:

<?php

class Modules_ExampleModule_WebServer extends \pm_Hook_WebServer
{
    public function getDomainNginxConfig(pm_Domain $domain)
    {
        return <<<EOL
            location /test/location/ { return 444; }
            EOL;
    }

    public function getDomainNginxProxyConfig(pm_Domain $domain)
    {
        return <<<EOL
            location /test/location/ { return 444; }
            EOL;
    }
}

Note that this hook in not PSR-4 compatible, namespaces are not supported there, so you will have to use the legacy underscore-separated name for this class. For the full list of methods that can be implemented in this hook you may refer to the pm-api-stubs: Documentation

This hook should be located in the src/plib/hooks directory of the extension:

╰─ ls -la src/plib/hooks/WebServer.php
-rw-r--r-- 1 abashurov abashurov 773 Jan 11 11:19 src/plib/hooks/WebServer.php