https://github.com/ryelle/wordpress-query-posts

A set of react & redux helpers for fetching posts from the WordPress REST API
https://github.com/ryelle/wordpress-query-posts

Last synced: 2 months ago
JSON representation

A set of react & redux helpers for fetching posts from the WordPress REST API

• Host: GitHub
• URL: https://github.com/ryelle/wordpress-query-posts
• Owner: ryelle
• Created: 2016-10-23T19:25:15.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2019-08-04T12:29:23.000Z (over 5 years ago)
• Last Synced: 2024-10-03T12:25:14.986Z (3 months ago)
• Language: JavaScript
• Homepage: https://npmjs.com/package/wordpress-query-posts
• Size: 600 KB
• Stars: 42
• Watchers: 3
• Forks: 7
• Open Issues: 10
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
WordPress Query Posts

=====================

This package contains a query component, along with redux state & selectors for posts pulled from a WordPress site. This uses the [`node-wpapi`](https://github.com/WP-API/node-wpapi) package to get your site's data via Query Components ([inspired by calypso](https://github.com/Automattic/wp-calypso/blob/master/docs/our-approach-to-data.md#query-components)). The Query Components call the API, which via actions set your site's data into the state.

To use any of these helpers, you'll need to set your Site URL in a global (`SiteSettings`), so that the API knows what site to connect to. For example:

```js

window.SiteSettings = {

	endpoint: 'url.com/path-to-wordpress',

};

```

As of version 1.1, the URL should _not_ include `/wp_json` – `wordpress-rest-api-oauth-1` adds that for us.

Query Posts

===========

Query Posts is a React component used in managing the fetching of posts queries, or single posts by the post slug.

## Usage

Used to request a single post, or list of posts, based on either a query object, or post slug.

Render the component, passing in the `query` or a single `postSlug`. It does not accept any children, nor does it render any elements to the page. You can use it adjacent to other sibling components which make use of the fetched data made available through the global application state.

```jsx

import React from 'react';

import QueryPosts from 'wordpress-query-posts';

import MyPostsListItem from './list-item';

export default function MyPostsList( { posts } ) {

	return (

		


			

			{ posts.map( ( post ) => {

				return (

					

				);

			} }

		

	);

}

```


or for a single post:

```jsx

import React from 'react';

import QueryPosts from 'wordpress-query-posts';

import SinglePost from './single';

export default function MyPostsList( { post } ) {

	return (

		


			

			

		

	);

}

```


## Props

### `query`

	TypeObject

	RequiredNo

	Defaultnull

The query to be used in requesting posts.

### `postSlug`

	TypeString

	RequiredNo

	Defaultnull

The post slug of the post to request.

Post Selectors

==============

You can import these into your project by grabbing them from the `selectors` file:

```jsx

import { getPost, isRequestingPost } from 'wordpress-query-posts/lib/selectors';

```

#### `getPost( state, globalId )`

#### `getPostsForQuery( state, query )`

#### `isRequestingPostsForQuery( state, query )`

#### `getTotalPagesForQuery( state, query )`

#### `isRequestingPost( state, postSlug )`

#### `getPostIdFromSlug( state, slug )`

Post State

==========

If you need access to the reducers, action types, or action creators, you can import these from the `state` file. For example, to use this in your global redux state, mix it into your reducer tree like this:

```jsx

import posts from 'wordpress-query-posts/lib/state';

let reducer = combineReducers( { ...otherReducers, posts } );

```

If you need to call an action (the query component should take care of this most of the time), you can pull the action out specifically:

```jsx

import { requestPost } from 'wordpress-query-posts/lib/state';

```

[View the file itself](src/state.js) to see what else is available.