Documentation

pm_Hook_CustomButtons
in package
implements pm_Hook_Interface

Hook for custom buttons embedding

Tags
since
12.0

Interfaces, Classes and Traits

pm_Hook_Interface
Generic interface for hooks

Table of Contents

PLACE_ADMIN_HOME  = 2
PLACE_ADMIN_NAVIGATION  = 12
PLACE_ADMIN_TOOLS_AND_SETTINGS  = 5
PLACE_COMMON  = 1
PLACE_CUSTOMER_HOME  = 4
PLACE_DOMAIN  = 8
PLACE_DOMAIN_HEADER_DYNAMIC  = 17
PLACE_DOMAIN_PROPERTIES  = 9
PLACE_DOMAIN_PROPERTIES_DYNAMIC  = 16
PLACE_HEADER_NAVIGATION  = 15
PLACE_HOSTING_PANEL_NAVIGATION  = 7
PLACE_HOSTING_PANEL_TABS  = 14
PLACE_LIST_ACTIONS  = 11
PLACE_RESELLER_HOME  = 3
PLACE_RESELLER_NAVIGATION  = 13
PLACE_RESELLER_TOOLS_AND_SETTINGS  = 6
PLACE_TOOLBAR  = 10
SECTION_ADMIN_TOOLS_ADDITIONAL_SERVICES  = 'customButtons'
SECTION_ADMIN_TOOLS_APPEARANCE  = 'uiButtons'
SECTION_ADMIN_TOOLS_APPS_AND_DBS  = 'applicationsAndDatabasesButtons'
SECTION_ADMIN_TOOLS_EXTERNAL_SERVICES  = 'myPleskButtons'
SECTION_ADMIN_TOOLS_GENERAL  = 'generalButtons'
SECTION_ADMIN_TOOLS_MAIL  = 'mailButtons'
SECTION_ADMIN_TOOLS_PLESK  = 'panelButtons'
SECTION_ADMIN_TOOLS_SECURITY  = 'securityButtons'
SECTION_ADMIN_TOOLS_SERVER_MANAGEMENT  = 'serverManagementButtons'
SECTION_ADMIN_TOOLS_STATISTICS  = 'statisticsButtons'
SECTION_ADMIN_TOOLS_TOOLS_AND_RESOURCES  = 'toolsAndResourcesButtons'
SECTION_ADMIN_TOOLS_TROUBLESHOOTING_BUTTONS  = 'troubleshootingButtons'
SECTION_DOMAIN_PROPS_DYNAMIC_DEV_TOOLS  = 'devTools'
SECTION_DOMAIN_PROPS_DYNAMIC_FILES_AND_DATABASES  = 'filesAndDatabases'
SECTION_DOMAIN_PROPS_DYNAMIC_HOSTING  = 'hosting'
SECTION_DOMAIN_PROPS_DYNAMIC_MAIL  = 'mail'
SECTION_DOMAIN_PROPS_DYNAMIC_SECURITY  = 'security'
SECTION_NAV_ADDITIONAL  = 'custom_buttons'
SECTION_NAV_GENERAL  = 'general'
SECTION_NAV_HOSTING  = 'hosting'
SECTION_NAV_PROFILE  = 'profile'
SECTION_NAV_SERVER_MANAGEMENT  = 'server_management'
SECTION_RESELLER_TOOLS_ADDITIONAL_SERVICES  = 'customButtons'
SECTION_RESELLER_TOOLS_PLESK_MANAGEMENT  = 'toolsButtons'
SECTION_RESELLER_TOOLS_RESOURCES  = 'resourcesButtons'
SECTION_RESELLER_TOOLS_SERVICES  = 'myPleskButtons'
getButtons()  : array<string|int, mixed>
Retrieve the list of buttons

Constants

PLACE_ADMIN_HOME

public mixed PLACE_ADMIN_HOME = 2
Tags
since
12.0

PLACE_ADMIN_NAVIGATION

public mixed PLACE_ADMIN_NAVIGATION = 12
Tags
since
17.0

PLACE_ADMIN_TOOLS_AND_SETTINGS

public mixed PLACE_ADMIN_TOOLS_AND_SETTINGS = 5
Tags
since
12.0

PLACE_CUSTOMER_HOME

public mixed PLACE_CUSTOMER_HOME = 4
Tags
since
12.0

PLACE_DOMAIN_HEADER_DYNAMIC

public mixed PLACE_DOMAIN_HEADER_DYNAMIC = 17
Tags
since
18.0.41

PLACE_DOMAIN_PROPERTIES

public mixed PLACE_DOMAIN_PROPERTIES = 9
Tags
since
12.0

PLACE_DOMAIN_PROPERTIES_DYNAMIC

public mixed PLACE_DOMAIN_PROPERTIES_DYNAMIC = 16
Tags
since
18.0

PLACE_HEADER_NAVIGATION

public mixed PLACE_HEADER_NAVIGATION = 15
Tags
since
17.8

PLACE_HOSTING_PANEL_NAVIGATION

public mixed PLACE_HOSTING_PANEL_NAVIGATION = 7
Tags
since
12.0

PLACE_HOSTING_PANEL_TABS

public mixed PLACE_HOSTING_PANEL_TABS = 14
Tags
since
17.0

PLACE_LIST_ACTIONS

public mixed PLACE_LIST_ACTIONS = 11
Tags
since
12.5

PLACE_RESELLER_HOME

public mixed PLACE_RESELLER_HOME = 3
Tags
since
12.0

PLACE_RESELLER_NAVIGATION

public mixed PLACE_RESELLER_NAVIGATION = 13
Tags
since
17.0

PLACE_RESELLER_TOOLS_AND_SETTINGS

public mixed PLACE_RESELLER_TOOLS_AND_SETTINGS = 6
Tags
since
12.0

PLACE_TOOLBAR

public mixed PLACE_TOOLBAR = 10
Tags
since
12.5

SECTION_ADMIN_TOOLS_ADDITIONAL_SERVICES

public mixed SECTION_ADMIN_TOOLS_ADDITIONAL_SERVICES = 'customButtons'
Tags
since
17.0

SECTION_ADMIN_TOOLS_APPEARANCE

public mixed SECTION_ADMIN_TOOLS_APPEARANCE = 'uiButtons'
Tags
since
17.0

SECTION_ADMIN_TOOLS_APPS_AND_DBS

public mixed SECTION_ADMIN_TOOLS_APPS_AND_DBS = 'applicationsAndDatabasesButtons'
Tags
since
17.0

SECTION_ADMIN_TOOLS_EXTERNAL_SERVICES

public mixed SECTION_ADMIN_TOOLS_EXTERNAL_SERVICES = 'myPleskButtons'
Tags
since
17.0

SECTION_ADMIN_TOOLS_GENERAL

public mixed SECTION_ADMIN_TOOLS_GENERAL = 'generalButtons'
Tags
since
17.0

SECTION_ADMIN_TOOLS_MAIL

public mixed SECTION_ADMIN_TOOLS_MAIL = 'mailButtons'
Tags
since
17.0

SECTION_ADMIN_TOOLS_PLESK

public mixed SECTION_ADMIN_TOOLS_PLESK = 'panelButtons'
Tags
since
17.0

SECTION_ADMIN_TOOLS_SECURITY

public mixed SECTION_ADMIN_TOOLS_SECURITY = 'securityButtons'
Tags
since
17.0

SECTION_ADMIN_TOOLS_SERVER_MANAGEMENT

public mixed SECTION_ADMIN_TOOLS_SERVER_MANAGEMENT = 'serverManagementButtons'
Tags
since
17.0

SECTION_ADMIN_TOOLS_STATISTICS

public mixed SECTION_ADMIN_TOOLS_STATISTICS = 'statisticsButtons'
Tags
since
17.0

SECTION_ADMIN_TOOLS_TOOLS_AND_RESOURCES

public mixed SECTION_ADMIN_TOOLS_TOOLS_AND_RESOURCES = 'toolsAndResourcesButtons'
Tags
since
17.0

SECTION_ADMIN_TOOLS_TROUBLESHOOTING_BUTTONS

public mixed SECTION_ADMIN_TOOLS_TROUBLESHOOTING_BUTTONS = 'troubleshootingButtons'
Tags
since
17.8

SECTION_DOMAIN_PROPS_DYNAMIC_DEV_TOOLS

public mixed SECTION_DOMAIN_PROPS_DYNAMIC_DEV_TOOLS = 'devTools'
Tags
since
18.0

SECTION_DOMAIN_PROPS_DYNAMIC_FILES_AND_DATABASES

public mixed SECTION_DOMAIN_PROPS_DYNAMIC_FILES_AND_DATABASES = 'filesAndDatabases'
Tags
since
18.0

SECTION_DOMAIN_PROPS_DYNAMIC_HOSTING

public mixed SECTION_DOMAIN_PROPS_DYNAMIC_HOSTING = 'hosting'
Tags
since
18.0

SECTION_DOMAIN_PROPS_DYNAMIC_MAIL

public mixed SECTION_DOMAIN_PROPS_DYNAMIC_MAIL = 'mail'
Tags
since
18.0

SECTION_DOMAIN_PROPS_DYNAMIC_SECURITY

public mixed SECTION_DOMAIN_PROPS_DYNAMIC_SECURITY = 'security'
Tags
since
18.0

SECTION_NAV_ADDITIONAL

public mixed SECTION_NAV_ADDITIONAL = 'custom_buttons'
Tags
since
17.0

SECTION_NAV_GENERAL

public mixed SECTION_NAV_GENERAL = 'general'
Tags
since
17.0

SECTION_NAV_HOSTING

public mixed SECTION_NAV_HOSTING = 'hosting'
Tags
since
17.0

SECTION_NAV_PROFILE

public mixed SECTION_NAV_PROFILE = 'profile'
Tags
since
17.0

SECTION_NAV_SERVER_MANAGEMENT

public mixed SECTION_NAV_SERVER_MANAGEMENT = 'server_management'
Tags
since
17.0

SECTION_RESELLER_TOOLS_ADDITIONAL_SERVICES

public mixed SECTION_RESELLER_TOOLS_ADDITIONAL_SERVICES = 'customButtons'
Tags
since
17.0

SECTION_RESELLER_TOOLS_PLESK_MANAGEMENT

public mixed SECTION_RESELLER_TOOLS_PLESK_MANAGEMENT = 'toolsButtons'
Tags
since
17.0

SECTION_RESELLER_TOOLS_RESOURCES

public mixed SECTION_RESELLER_TOOLS_RESOURCES = 'resourcesButtons'
Tags
since
17.0

SECTION_RESELLER_TOOLS_SERVICES

public mixed SECTION_RESELLER_TOOLS_SERVICES = 'myPleskButtons'
Tags
since
17.0

Methods

getButtons()

Retrieve the list of buttons

public abstract getButtons() : array<string|int, mixed>
[
    [
        'place' => self::PLACE_DOMAIN_PROPERTIES_DYNAMIC,
        'section' => self::SECTION_DOMAIN_PROPS_DYNAMIC_DEV_TOOLS,
        'title' => 'Example Button',
        'description' => 'Description for example button',
        'icon' => pm_Context::getBaseUrl() . 'images/icon.png',
        'link' => pm_Context::getBaseUrl() . 'index.php/index/index',
        'newWindow' => false,
        'contextParams' => true,
        'visibility' => [$this, 'isExampleButtonVisible'],
    ],
    ...
]
Return values
array<string|int, mixed>

Search results