README

一个基于React、类似堆叠显示的按类别划分的WordPress REST端点帖子。

演示。

安装

Composer/WordPress

如果您打算使用WordPress短代码，此库可以通过Composer安装或作为WordPress插件激活。要通过Composer安装，请使用以下命令

composer require johnwatkins0/wp-react-stories

注意，此插件的WordPress部分需要 PHP 7.1 或更高版本。

从NPM安装

如果您不使用短代码并计划将此库导入到ES6 JavaScript中，请使用npm安装

npm install wp-react-stories

或者

yarn add wp-react-stories

用法

在ES6 JavaScript中

首先，如果您使用Composer安装了此库并计划将组件导入到JavaScript中，您需要防止插件编译后的脚本被队列。在您的WordPress项目中，添加以下过滤器

add_filter( 'johnwatkins0__stories__enqueue_script', '__return_false' );

在项目中包含 Stories 组件，例如

import React from 'react';
import ReactDOM from 'react';
import Stories from 'wp-react-stories';

const myContainer = document.querySelector('#my-container-element');
const myProps = {
    // See below.
}

ReactDOM.render(<Stories {...myProps} />, myContainer);

属性

endpoint {字符串} 必需

用于获取帖子的WordPress REST端点，例如 http://your-site.com/wp-json/wp/v2/posts/。自定义端点必须支持参数 search、page、categories 和 per_page。

categoriesEndpoint {字符串} 必需

用于获取类别的WordPress REST端点，例如 http://your-site.com/wp-json/wp/v2/categories/。

mediaEndpoint {字符串} 必需

用于获取媒体的WordPress REST端点，例如 http://your-site.com/wp-json/wp/v2/media/。

perPage {字符串} 默认 = 12

每页显示帖子的数量。

在WordPress中

要使用此插件而不进行ES6包含，只需使用Composer安装或激活它作为插件，然后使用此短代码

[stories endpoint="http://my-site.com/wp-json/wp-v2/posts/"]

所有短代码属性都有默认值（见下文），因此如果所有默认值都适用，只需使用 [stories]。

短代码属性

endpoint 默认 = get_bloginfo( 'url' ) . '/wp-json/wp/v2/posts/'

用于获取帖子的WordPress REST端点。

categories-endpoint 默认 = get_bloginfo( 'url' ) . '/wp-json/wp/v2/categories/'

用于获取类别的WordPress REST端点。

media-endpoint 默认 = get_bloginfo( 'url' ) . '/wp-json/wp/v2/media/'

用于获取媒体文件的WordPress REST端点。

per-page 默认 = '12'

每页显示帖子的数量。