Page tree
Skip to end of metadata
Go to start of metadata

Description

This function configures a WordPress® cPAddon instance's automatic updates settings.

Important:

This function changes the instance's automatic update setting in the wp-config.php file. Before you run this function, you should verify that a filter does not exist for the automatic update settings. Use the get_instance_by_id function and view the autoupdate.core.has_filter return to determine if a filter exists.

Note:

You must install the WordPress Manager cPanel plugin to access this API function.

Examples


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/WordPressInstanceManager/configure_autoupdate?id=cPanel__Blogs__WordPressX.0.1491917088&autoupdate.core.major=0&autoupdate.core.minor=0

Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Configure a single WordPress instance's automatic update settings.
 $instances = $cpanel->uapi(
    'WordPressInstanceManager', 'configure_autoupdate',
	    array(
        'id'         			=> 'cPanel__Blogs__WordPressX.0.1491917088',
		'autoupdate.core.major'	=> '0',
		'autoupdate.core.minor' => '0',
        )
);

Note:

For more information, read our Guide to the LiveAPI System.

 LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Configure a single WordPress instance's automatic update settings.
my $instances = $cpliveapi->uapi(
    'WordPressInstanceManager', 'get_instance_by_id',
	    {
        'id'        			=> 'cPanel__Blogs__WordPressX.0.1491917088',
		'autoupdate.core.major'	=> '0',
		'autoupdate.core.minor' => '0',
        }
);

Note:

For more information, read our Guide to the LiveAPI System.

 cPanel Template Toolkit
<!-- Configure a single WordPress instance's automatic update settings.. -->
[% data = execute( 'WordPressInstanceManager', 'configure_autoupdate'{ 'id' => 'cPanel__Blogs__WordPressX.0.1491917088','autoupdate.core.major' => '0', 'autoupdate.core.minor' => '0', } ); %]

Note:

For more information, read our Guide to Template Toolkit documentation. 

 Command Line
uapi --user=username WordPressInstanceManager configure_autoupdate id=cPanel__Blogs__WordPressX.0.1491917088 autoupdate.core.major=0 autoupdate.core.minor=0

Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • We introduced this functionality in cPanel & WHM version 56.

 Output (JSON)
{
	"status": 1,
	"messages": null,
	"errors": null,
	"metadata": {},
	"data": null
}

Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

ParameterTypeDescriptionPossible valuesExample
idstring

Required

The cPAddon instance's unique ID.

Note:

You can retrieve an instance ID with the get_instances function.

A valid instance ID.cPanel__Blogs__WordPressX.0.1491917088
autoupdate.core.majorBoolean

Required

Whether to enable automatic updates for major releases.

  • 1 — Enable.
  • 0 — Disable.
0
autoupdate.core.minorBoolean

Required

Whether to enable automatic updates for minor releases.

  • 1 — Enable.
  • 0 — Disable.
0

 

Returns

This function only returns metadata.

  • No labels