WordPress
Create, find, update and delete posts, pages, users, media, categories and tags on a WordPress site.
Connect WordPress
- In the sidebar, open Connections and press Add connection.
- Type
wordpressand choose WordPress. - Choose Sign in with WordPress.
- Press Sign in with WordPress at the bottom of the sheet, then choose your account in WordPress’s window and allow access.
Or choose Paste your application password, paste it, and press Test and save. It stays until someone deletes it.
Enter your site’s address, a user name and an application password (WordPress admin › Users › Profile › Application Passwords; the user’s role decides what the connection may do; the site must be served over https). For a site hosted on WordPress.com you can sign in with WordPress.com instead.
What if it says “Sign-in isn’t set up here yet”?
Signing in with WordPress needs a WordPress app on this installation, and it has none yet. Until it is set up, Paste your application password works without it.
On Cloud: The sheet says “It’s set up once for everyone who uses this service, not by an organization.”
Self-hosted: An admin of the installation sees Set up WordPress sign-in instead, and sets it up once for everyone. Everyone else sees who to ask.
- Create an app in WordPress’s developer settings (WordPress’s guide).
- In GoRunner, copy the Redirect address to add in WordPress’s developer settings, and add it to the app.
- Paste the Client ID and Client secret, then press Save and sign in.
Can I use my own WordPress app?
Yes. In the sheet, open Use your own WordPress app and paste its Client ID and Client secret. Add the redirect address it shows to your app first. The connection then signs in through your app instead of the installation’s.
Connections says how to sign in again, rename or delete it. In a product that embeds GoRunner, Add connection can be missing: then your provider makes connections for you.
Do things in WordPress
Add a WordPress step, choose a Resource, then an Operation. Choose a row to see its fields.
- PostCreate · Get · Get Many · Update · Delete
- PageCreate · Get · Get Many · Update · Delete
- UserCreate · Get · Get Many · Update · Delete
- MediaUpload · Get · Get Many · Update · Delete
- CategoryCreate · Get · Get Many · Update · Delete
- TagCreate · Get · Get Many · Update · Delete
To start a workflow from WordPress, use a Schedule, Webhook or Form trigger.
Later steps read a step’s output by its name: see Use data from earlier steps.
Limits
- A reply from WordPress can be up to 16 MB (a file download can have its own limit). A larger one fails the step; it is never cut short.
- When WordPress says to slow down (429), the step waits as long as it asks, if the step’s time allows. Otherwise it fails and says when to try again.
Not in your list? See When an app isn’t here.
For developers
In the API, which calls apps pieces, WordPress is pieceId: "wordpress" with actionId: "wordpress", set by resource and an operation_… field, such as operation_category. Get an app returns every field.
It can change something outside the run (writes_external). See How versions and side effects work.
WordPress › Post
Create
- Title · Optional
The title.
- Content · Optional
The content, as HTML or block markup.
- Excerpt · Optional
A short summary shown in lists and feeds.
- Status · Optional
Published, scheduled (with a future Date), draft, pending review or private. Empty on Create: a draft.
Options: Published, Scheduled, Draft, Pending review, Private.
- Author · Optional
The user shown as the author. Empty on Create: the connection's user.
- Slug · Optional
The address part, such as launch-note.
- Password Protect · Optional
A password visitors must enter to read it.
- Date · Optional
The publish date, in the site's time zone (a future date with Scheduled status publishes then).
- Featured Image · Optional
The media id of the featured image (from Media › Upload).
- Comments · Optional
Whether visitors may comment.
Options: Open, Closed.
- Pingbacks · Optional
Whether other sites may ping it.
Options: Open, Closed.
- Template · Optional
The theme template file to show it with.
- Format · Optional
The post format (if the theme uses formats).
Options: standard, aside, chat, gallery, link, image, quote, status, video, audio.
- Sticky · Optional
Keep it at the top of the blog's front page. Empty: leave it as it is.
Options: Yes, No.
- Categories · Optional
Category ids, separated by commas (Category › Get Many lists them).
- Tags · Optional
Tag ids, separated by commas (Tag › Get Many lists them).
Get
- Post · Required
The post's id (a number).
Get Many
- Search · Optional
Only posts matching these words.
- Status · Optional
Only posts with this status. Empty: published.
Options: any, publish, future, draft, pending, private, trash.
- Author · Optional
Only posts by this user.
- Categories · Optional
Only posts in these categories (ids, separated by commas).
- Tags · Optional
Only posts with these tags (ids, separated by commas).
- Sticky · Optional
Only sticky posts, or only posts that are not. Empty: leave it as it is.
Options: Yes, No.
- Published After · Optional
- Published Before · Optional
- Order By · Optional
What to sort by. Empty: WordPress's default for the list.
Options: date, modified, title, id, slug, author, relevance, include.
- Direction · Optional
Sort direction. Empty: WordPress's default.
Options: Descending, Ascending.
- Return All · Optional
Read every post, page by page (at most 2000; past that the step fails rather than stop early).
Off by default.
- Limit · Optional
How many posts to return (1–2000).
Default: 50.
Shows when Return All is off.
Update
- Post · Required
The post's id (a number).
- Title · Optional
The title.
- Content · Optional
The content, as HTML or block markup.
- Excerpt · Optional
A short summary shown in lists and feeds.
- Status · Optional
Published, scheduled (with a future Date), draft, pending review or private. Empty on Create: a draft.
Options: Published, Scheduled, Draft, Pending review, Private.
- Author · Optional
The user shown as the author. Empty on Create: the connection's user.
- Slug · Optional
The address part, such as launch-note.
- Password Protect · Optional
A password visitors must enter to read it.
- Date · Optional
The publish date, in the site's time zone (a future date with Scheduled status publishes then).
- Featured Image · Optional
The media id of the featured image (from Media › Upload).
- Comments · Optional
Whether visitors may comment.
Options: Open, Closed.
- Pingbacks · Optional
Whether other sites may ping it.
Options: Open, Closed.
- Template · Optional
The theme template file to show it with.
- Format · Optional
The post format (if the theme uses formats).
Options: standard, aside, chat, gallery, link, image, quote, status, video, audio.
- Sticky · Optional
Keep it at the top of the blog's front page. Empty: leave it as it is.
Options: Yes, No.
- Categories · Optional
Category ids, separated by commas (Category › Get Many lists them).
- Tags · Optional
Tag ids, separated by commas (Tag › Get Many lists them).
Delete
- Post · Required
The post's id (a number).
- Delete Permanently · Optional
Off: move it to the trash (it can be restored). On: delete it for good.
Off by default.
WordPress › Page
Create
- Title · Optional
The title.
- Content · Optional
The content, as HTML or block markup.
- Excerpt · Optional
A short summary shown in lists and feeds.
- Status · Optional
Published, scheduled (with a future Date), draft, pending review or private. Empty on Create: a draft.
Options: Published, Scheduled, Draft, Pending review, Private.
- Author · Optional
The user shown as the author. Empty on Create: the connection's user.
- Slug · Optional
The address part, such as launch-note.
- Password Protect · Optional
A password visitors must enter to read it.
- Date · Optional
The publish date, in the site's time zone (a future date with Scheduled status publishes then).
- Featured Image · Optional
The media id of the featured image (from Media › Upload).
- Comments · Optional
Whether visitors may comment.
Options: Open, Closed.
- Pingbacks · Optional
Whether other sites may ping it.
Options: Open, Closed.
- Template · Optional
The theme template file to show it with.
- Parent Page · Optional
The page this page sits under.
- Menu Order · Optional
Its place among its sibling pages.
Get
- Page · Required
The page's id (a number).
Get Many
- Search · Optional
Only pages matching these words.
- Status · Optional
Only pages with this status. Empty: published.
Options: any, publish, future, draft, pending, private, trash.
- Author · Optional
Only pages by this user.
- Parent Page · Optional
Only the pages under this page.
- Published After · Optional
- Published Before · Optional
- Order By · Optional
What to sort by. Empty: WordPress's default for the list.
Options: date, modified, title, id, slug, author, menu_order, parent, relevance, include.
- Direction · Optional
Sort direction. Empty: WordPress's default.
Options: Descending, Ascending.
- Return All · Optional
Read every page, page by page (at most 2000; past that the step fails rather than stop early).
Off by default.
- Limit · Optional
How many pages to return (1–2000).
Default: 50.
Shows when Return All is off.
Update
- Page · Required
The page's id (a number).
- Title · Optional
The title.
- Content · Optional
The content, as HTML or block markup.
- Excerpt · Optional
A short summary shown in lists and feeds.
- Status · Optional
Published, scheduled (with a future Date), draft, pending review or private. Empty on Create: a draft.
Options: Published, Scheduled, Draft, Pending review, Private.
- Author · Optional
The user shown as the author. Empty on Create: the connection's user.
- Slug · Optional
The address part, such as launch-note.
- Password Protect · Optional
A password visitors must enter to read it.
- Date · Optional
The publish date, in the site's time zone (a future date with Scheduled status publishes then).
- Featured Image · Optional
The media id of the featured image (from Media › Upload).
- Comments · Optional
Whether visitors may comment.
Options: Open, Closed.
- Pingbacks · Optional
Whether other sites may ping it.
Options: Open, Closed.
- Template · Optional
The theme template file to show it with.
- Parent Page · Optional
The page this page sits under.
- Menu Order · Optional
Its place among its sibling pages.
Delete
- Page · Required
The page's id (a number).
- Delete Permanently · Optional
Off: move it to the trash (it can be restored). On: delete it for good.
Off by default.
WordPress › User
Create
- User Name · Required
The login name. It cannot be changed later.
- Email · Optional
The user's email address. Required on Create.
- Password · Optional
The user's password. Required on Create.
- Display Name · Optional
The name shown on the site.
- First Name · Optional
- Last Name · Optional
- Nickname · Optional
- Role · Optional
The user's role. Empty on Create: the site's default role.
Options: Subscriber, Contributor, Author, Editor, Administrator.
- Website · Optional
The user's website.
- Biographical Info · Optional
- Slug · Optional
The address part of the author page.
- Language · Optional
The user's language, such as en_US or de_DE.
Get
- User · Required
The user's id (a number).
Get Many
- Search · Optional
Only users matching these words.
- Role · Optional
Only users with this role.
Options: subscriber, contributor, author, editor, administrator.
- Order By · Optional
What to sort by. Empty: WordPress's default for the list.
Options: name, id, registered_date, slug, email, url, include.
- Direction · Optional
Sort direction. Empty: WordPress's default.
Options: Descending, Ascending.
- Return All · Optional
Read every user, page by page (at most 2000; past that the step fails rather than stop early).
Off by default.
- Limit · Optional
How many users to return (1–2000).
Default: 50.
Shows when Return All is off.
Update
- User · Required
The user's id (a number).
- Email · Optional
The user's email address. Required on Create.
- Password · Optional
The user's password. Required on Create.
- Display Name · Optional
The name shown on the site.
- First Name · Optional
- Last Name · Optional
- Nickname · Optional
- Role · Optional
The user's role. Empty on Create: the site's default role.
Options: Subscriber, Contributor, Author, Editor, Administrator.
- Website · Optional
The user's website.
- Biographical Info · Optional
- Slug · Optional
The address part of the author page.
- Language · Optional
The user's language, such as en_US or de_DE.
Delete
- User · Required
The user's id (a number).
- Give Their Content To · Required
The user who gets the deleted user's posts and links. WordPress requires one; deleting is permanent.
WordPress › Media
Upload
- File · Required
Upload a file, or switch to an expression to use one from an earlier step (such as {{steps.download.result}}). Images, documents, audio or video the site allows.
- File Name · Optional
The name the file gets in the media library. Empty: the file's own name.
- Title · Optional
- Alternative Text · Optional
What the image shows, for people who cannot see it.
- Caption · Optional
- Description · Optional
- Attach To Post · Optional
The id of the post or page the file belongs to.
Get and Delete
- Media Item · Required
The media item's id (a number).
Get Many
- Search · Optional
Only media items matching these words.
- Kind · Optional
Only files of this kind.
Options: image, video, audio, text, application.
- MIME Type · Optional
Only files of this exact type, such as image/png.
- Attached To · Optional
Only files attached to this post or page id.
- Order By · Optional
What to sort by. Empty: WordPress's default for the list.
Options: date, modified, title, id, slug, author, relevance, include.
- Direction · Optional
Sort direction. Empty: WordPress's default.
Options: Descending, Ascending.
- Return All · Optional
Read every media item, page by page (at most 2000; past that the step fails rather than stop early).
Off by default.
- Limit · Optional
How many media items to return (1–2000).
Default: 50.
Shows when Return All is off.
Update
- Media Item · Required
The media item's id (a number).
- Title · Optional
- Alternative Text · Optional
What the image shows, for people who cannot see it.
- Caption · Optional
- Description · Optional
- Attach To Post · Optional
The id of the post or page the file belongs to.
WordPress › Category
Create
- Name · Optional
Required on Create.
- Description · Optional
- Slug · Optional
- Parent Category · Optional
The category this one sits under.
Get and Delete
- Category · Required
The category's id (a number).
Get Many
- Search · Optional
Only categorys matching these words.
- Parent Category · Optional
Only the categories directly under this one.
- Hide Unused · Optional
Leave out categories no post uses.
Off by default.
- Order By · Optional
What to sort by. Empty: WordPress's default for the list.
Options: name, id, slug, count, description, include, term_group.
- Direction · Optional
Sort direction. Empty: WordPress's default.
Options: Descending, Ascending.
- Return All · Optional
Read every category, page by page (at most 2000; past that the step fails rather than stop early).
Off by default.
- Limit · Optional
How many categorys to return (1–2000).
Default: 50.
Shows when Return All is off.
Update
- Category · Required
The category's id (a number).
- Name · Optional
Required on Create.
- Description · Optional
- Slug · Optional
- Parent Category · Optional
The category this one sits under.
WordPress › Tag
Create
- Name · Optional
Required on Create.
- Description · Optional
- Slug · Optional
Get and Delete
- Tag · Required
The tag's id (a number).
Get Many
- Search · Optional
Only tags matching these words.
- Hide Unused · Optional
Leave out tags no post uses.
Off by default.
- Order By · Optional
What to sort by. Empty: WordPress's default for the list.
Options: name, id, slug, count, description, include, term_group.
- Direction · Optional
Sort direction. Empty: WordPress's default.
Options: Descending, Ascending.
- Return All · Optional
Read every tag, page by page (at most 2000; past that the step fails rather than stop early).
Off by default.
- Limit · Optional
How many tags to return (1–2000).
Default: 50.
Shows when Return All is off.
Update
- Tag · Required
The tag's id (a number).
- Name · Optional
Required on Create.
- Description · Optional
- Slug · Optional