| Methods |
public
|
plugin_status(string $hostname, string $path = '', string $plugin = null)
|
#
|
public
|
uninstall_plugin(string $hostname, string $path, string $plugin, bool $force = false): bool
|
#
|
public
|
disable_all_plugins(string $hostname, string $path = ''): bool
|
#
|
public
|
restart(string $hostname, string $path = ''): bool
|
#
|
public
|
install(string $hostname, string $path = '', array $opts = []): bool
Install Ghost into a pre-existing location
Install Ghost into a pre-existing location
Parameters
| $hostname |
domain or subdomain to install Laravel
|
| $path |
optional path under hostname
|
| $opts |
additional install options
|
|
#
|
public
|
get_version(string $hostname, string $path = ''): string
Get installed version
|
#
|
public
|
valid(string $hostname, string $path = ''): bool
Location is a valid Ghost install
Location is a valid Ghost install
Parameters
|
#
|
public
|
change_admin(string $hostname, string $path, array $fields): bool
Change Ghost admin credentials
Change Ghost admin credentials
Common fields include: password, email, name; email doubles as login
|
#
|
public
|
get_admin(string $hostname, null|string $path = ''): string
Get the primary admin for a WP instance
Get the primary admin for a WP instance
Returns
admin or false on failure
|
#
|
public
|
db_config(string $hostname, string $path = ''): bool|array
Get database configuration for a blog
Get database configuration for a blog
Parameters
| $hostname |
domain or subdomain of wp blog
|
| $path |
optional path
|
|
#
|
public
|
install_plugin(string $hostname, string $path, string $plugin, string $version = 'stable'): bool
Install and activate plugin
Install and activate plugin
Parameters
| $hostname |
domain or subdomain of wp install
|
| $path |
optional path component of wp install
|
| $plugin |
plugin name
|
| $version |
optional plugin version
|
|
#
|
public
|
uninstall(string $hostname, string $path = '', string $delete = 'all'): bool
Uninstall WP from a location
Uninstall WP from a location
Parameters
| $delete |
remove all files under docroot
|
|
#
|
public
|
update_all(string $hostname, string $path = '', string $version = null): bool
Update core, plugins, and themes atomically
Update core, plugins, and themes atomically
Parameters
| $hostname |
subdomain or domain
|
| $path |
optional path under hostname
|
|
#
|
public
|
update(string $hostname, string $path = '', string $version = null): bool
Update Ghost to latest version
Update Ghost to latest version
Parameters
| $hostname |
domain or subdomain under which WP is installed
|
| $path |
optional subdirectory
|
|
#
|
public
|
get_versions(): array
Get all available Ghost versions
Get all available Ghost versions
|
#
|
public
|
get_installable_versions(): array
|
#
|
public
|
update_plugins(string $hostname, string $path = '', array $plugins = []): bool
Update plugins
Parameters
| $hostname |
domain or subdomain
|
| $path |
optional path within host
|
|
#
|
public
|
update_themes(string $hostname, string $path = '', array $themes = []): bool
Update Laravel themes
Parameters
| $hostname |
subdomain or domain
|
| $path |
optional path under hostname
|
|
#
|
public
|
has_fortification(string $hostname, string $path = '', string $mode = null): bool
|
#
|
public
|
fortify(string $hostname, string $path = '', string $mode = 'max', array $args = []): bool
Restrict write-access by the app
Restrict write-access by the app
|
#
|