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

Description

This function retrieves the WordPress Manager plugin's version.

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/get_api_version

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.
 
// Retrieves the WordPress Manager plugin's version.
 $instances = $cpanel->uapi(
    'WordPressInstanceManager', 'get_api_version',
	    array(
        )
);

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.
 
# Retrieves the WordPress Manager plugin's version.
my $instances = $cpliveapi->uapi(
    'WordPressInstanceManager', 'get_api_version',
	    {
        }
);

Note:

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

 cPanel Template Toolkit
<!-- Retrieves the WordPress Manager plugin's version -->
[% data = execute( 'WordPressInstanceManager', 'get_api_version'{ } ); %]

Note:

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

 Command Line
uapi --user=username WordPressInstanceManager get_api_version

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)
{
	"errors": null,
	"status": 1,
	"metadata": {},
	"data": {
		"version": "1.0.1-0"
	},
	"messages": null
}

Note:

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

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
versionstringThe WordPress Manager plugin's version.

A version number in the X.Y-Z format, where:

  • X represents the major version.
  • Y represents the minor version.
  • Z represents the build version.
1.0.1-0