Child pages
  • The modify_accounts Script
This documentation is for cPanel & WHM version 84 CURRENT builds.  The "RELEASE" version of our documentation can be found in the Version 82 Documentation space.

Skip to end of metadata
Go to start of metadata


You can use the /usr/local/cpanel/usr/local/cpanel/scripts/modify_accounts script to set existing cPanel accounts to use a new theme.  

The /usr/local/cpanel/scripts/modify_accounts script

To use this script, run the following command as the root user:

/usr/local/cpanel/scripts/modify_accounts --theme=theme_name [options]


In this example, theme_name represents the name of the theme to which you wish to set for the package.


The /usr/local/cpanel/scripts/modify_accounts script accepts the following arguments:



The theme name that you wish to assign to the account. Specify the paper_lantern theme or the name of another valid theme that exists on the server.

/usr/local/cpanel/scripts/modify_accounts --theme=paper_lantern
--users A comma-separated list of the cPanel accounts that you wish to modify.
/usr/local/cpanel/scripts/modify_accounts --theme=paper_lantern --users=user1,user2
--all-usersUpdate all of the cPanel accounts that exist on the server.
/usr/local/cpanel/scripts/modify_accounts --theme=paper_lantern --all-users

Update all of the cPanel accounts that a specific reseller owns.


This argument only accepts one reseller value.  

/usr/local/cpanel/scripts/modify_accounts --theme=paper_lantern --all-users-from-reseller=reseller

The style that you wish to use for the specified theme.

  • Specify a cPanel-provided system-level theme (basic, retro, dark, or light) or a style that exists in the /var/cpanel/customizations directory.
  • If you specify a style name that exists both as a system-level theme and in the /var/cpanel/customizations directory, the script will use the /var/cpanel/customizations directory's style.
/usr/local/cpanel/scripts/modify_accounts --theme=paper_lantern --all-users --style=basic

Additional documentation