PowerShell module for managing the WordPress site
For detailed API reference, see the WordPress REST API documentation.
| Category | Function Name |
|---|---|
| Authentication | Connect-WordPress |
| Users | Get-WordPressUser, New-WordPressUser, Remove-WordPressUser, Update-WordPressUser |
| Media | Get-WordPressMedia, New-WordPressMedia, Remove-WordPressMedia, Update-WordPressMedia |
| Pages | Get-WordPressPage |
| Posts | Get-WordPressPost, Remove-WordPressPost |
| Plugins | Get-WordPressPlugin |
First, you'll need an application password for your WordPress account:
- Log in to your WordPress admin dashboard.
- Navigate to User > > Application Passwords.
- Click on "Add New".
- Fill in the application name.
- Copy the generated password and store it securely, as you won't be able to see it again.
- You can use the
Connect-WordPressfunction to establish a connection using your API credentials.
# PowerShellGet 2.x
#Install-Module -Name WordPressPS -Repository PSGallery
# PowerShellGet 3.x
Install-PSResource -Name WordPressPS
Import-Module WordPressPS
# List all available cmdlets provided by the module
Get-Command -Module WordPressPS
# Connect to your WordPress site using application password
$credential = Get-Credential -Message "Enter your username/application password"
Connect-WordPress -Credential $credential -SiteUrl "https://yourwordpress.com"
# List existing users
Get-WordPressUser | Select-Object id, slug, name, description| Format-Table
# Get existing media items
Get-WordPressMedia | Select-Object id, media_type,slug,alt_text,modified| Format-Table
# List posts
Get-WordPressPost | Select-Object id, slug, status, modified, @{Name='title.rendered'; Expression = { $_.title.rendered }} | Format-Table
# Get installed plugins
Get-WordPressPlugin | Select-Object version, plugin, name, author, status| Format-Table