wp-rest-api-posts-wordcount
v0.2.0
Published
Using the WP REST API, get the title, URL, content text, and number of characters in the content of all published articles of the target WordPress in JSON format.
Downloads
9
Maintainers
Readme
wp-rest-api-posts-wordcount
Using the WP REST API, get the title, URL, content text, and number of characters in the content of all published articles of the target WordPress in JSON format.
Install
npm install wp-rest-api-posts-wordcount
# or
yarn add wp-rest-api-posts-wordcount
Usage
Support CJS/ESM/UMD
.
CommonJS
const getWordcountList = require('wp-rest-api-posts-wordcount');
(async () => {
try {
const response = await getWordcountList('your wordpress url');
console.log(response);
} catch (e) {
console.error(e);
}
})();
ES Modules
import getWordcountList from('wp-rest-api-posts-wordcount');
try {
const response = await getWordcountList('your wordpress url');
console.log(response);
} catch (e) {
console.error(e);
}
UMD
After loading the script, it is available with the function name GetWPWordcountList
.
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width" />
<title>UMD Sample</title>
<script src="/node_modules/wp-rest-api-posts-wordcount/dist/umd/wp-rest-api-posts-wordcount.umd.cjs"></script>
</head>
<body>
<div>
<input type="text" id="url" />
<button id="search">Search</button>
</div>
<script>
document.getElementById('search').addEventListener('click', async (e) => {
const url = document.getElementById('url').value;
const response = await GetWPWordcountList(url);
console.log({ response });
});
</script>
</body>
</html>
Returns the result.
[
{
title: 'Post title',
url: 'Post url',
content: 'content text',
wordcount: word count(Number of characters in the content),
publishDate: '2020-01-01T00:00:00'
},
{
title: 'Post title',
url: 'Post url',
content: 'content text',
wordcount: word count(Number of characters in the content),
publishDate: '2020-02-01T00:00:00'
},
{
title: 'Post title',
url: 'Post url',
content: 'content text',
wordcount: word count(Number of characters in the content),
publishDate: '2020-03-01T00:00:00'
},
...
]
Sort options
It is possible to sort by either wordcount or publishDate.
wordcount: asc
const response = await getWordcountList('your wordpress url', {
sort: { wordcount: 'asc' },
});
wordcount: desc
const response = await getWordcountList('your wordpress url', {
sort: { wordcount: 'desc' },
});
publishDate: asc
const response = await getWordcountList('your wordpress url', {
sort: { publishDate: 'asc' },
});
publishDate: desc
const response = await getWordcountList('your wordpress url', {
sort: { publishDate: 'desc' },
});
Development
test
npm run test