WordPressの公開されている全記事の文字数を取得するnpmライブラリ
WordPressの記事の文字数を一覧で取得するためのライブラリをバージョンアップした
WP REST APIを用いてWordPressの公開されている全記事の文字数をゲットするnpmライブラリ。今まで自分用にずっと使っていたやつですが、今回コードを整えてバージョンアップしました。https://t.co/KHv8YXaBdA
— Yuki Shindo (@shinshin86) 2022年4月28日
WordPressに用意されているREST APIを用いて、WordPressで公開されている全記事の文字数を取得するためのnpmライブラリをこの度バージョンアップさせた。
もともと去年ぐらいから自分のためにずっと使っていたものだったが、今回、人様からも使われるようにとコードを整理し、かつソートのためのオプションを追加した形でバージョンアップさせた。
使い方自体は非常にシンプルで、
npm install wp-rest-api-posts-wordcount
# or
yarn add wp-rest-api-posts-wordcount
でインストールした後、
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); } })();
という感じで利用できる。
オプションなどについてはREADMEをご参照ください。
(というか、ここに書いたのも、READMEに書いてある内容なのだが)
WP REST APIとは
このライブラリで利用しているWP REST APIについて簡単に書いておくと、WordPressでは下記のようなREST APIのためのエンドポイントが用意されている。
WordPress側の設定でこれは無効にすることもできるが、たぶん現在は設定を変えていなければ有効になっていたような気がする。
このREST APIを用いることで公開されている記事に関する情報を取得することができる。
例えばresponseヘッダーにある x-wp-total
という値をチェックすることで、対象となるWordPressのページ数なども取得できるので、色々とドキュメントを読んでみると面白い。
(実際に x-wp-total
については自身のnpmライブラリ内でも参照している)