WordPress | Yext Hitchhikers Platform

Overview

Use the WordPress source to pull in your Posts, Pages, Media, and Custom Content Types.

This source uses the WordPress API to:

Authentication

Most WordPress sites have public API endpoints that can be accessed without authentication; however, the WordPress source supports private sites through additional operations.

Installation instructions will ask users to create a new application password on their WordPress site. These credentials (WordPress username and application password) will be used to authenticate any private operation. See WordPress documentation for steps to create an application password.

Pagination

WordPress utilizes page-based pagination.


Page Key	page
Page Start Value	1
Limit Key	X-WP=Total
Limit Value	n/a
Total Pages Key	X-WP-TotalPages
Total Pages Key In	Header
Max Page Count	n/a

Fetch Posts

Use this operation to fetch Posts from your WordPress site.

Requirements

Users must enter a full WordPress URL (e.g., https://www.yoursite.com) and select Posts from the Content Type dropdown. A WordPress username and application password are required in order to authenticate the Private API operation.

Fields

id
title.rendered
content.rendered
sticky
date
modified
_embedded.author[].name
_embedded.author[].link
_embedded.author[].description
excerpt.rendered
link
_embedded."wp:featuredmedia"[].link
tags
_embedded."wp:term"[].name

Fetch Pages

Use this operation to fetch Pages from your WordPress site.

Requirements

Users must enter a full WordPress URL (e.g., https://www.yoursite.com) and select Pages from the Content Type dropdown. A WordPress username and application password are required in order to authenticate the Private API operation.

Fields

id
title.rendered
date
modified
_embedded.author[].name
_embedded.author[].link
_embedded.author[].description
link

Fetch Media

Use this operation to fetch Media from your WordPress site.

Requirements

Users must enter a full WordPress URL (e.g., https://www.yoursite.com) and select Media from the Content Type dropdown. A WordPress username and application password are required in order to authenticate the Private API operation.

Fields

id
title.rendered
date
modified
caption.rendered
alt_text
media_type
media_details.width
media_details.height
source_url
_embedded.author[].name
_embedded.author[].link
_embedded.author[].description

Fetch Custom Content

Use this operation to fetch Media from your WordPress site.

Requirements

Users must enter a full WordPress URL (e.g., https://www.yoursite.com) and input a WordPress content type (e.g, categories, users, etc.). A WordPress username and application password are required in order to authenticate the Private API operation.

Back

< WooCommerce

X (Formerly Twitter) >

<% elem.innerText %>