MornRain Reading Time

An estimated reading time notice, prepended automatically to every single post.

MornRain Reading Time is a lightweight, self-contained WordPress plugin by MornRain. It makes no outbound network requests, loads no external CDN assets, creates no custom database tables and touches no user data beyond what the site owner explicitly configures.

Table of contents

1. Features
2. Installation
3. Configuration
4. Hooks reference
5. File structure
6. Development and quality checks
7. Frequently asked questions
8. Changelog
9. License

Features

• Prepends an estimated reading time notice to singular content.
• Counts Latin words and CJK characters separately, so mixed-language posts stay accurate.
• Never touches excerpts, archives or feeds.
• Guards against duplicate output when the_content runs more than once.
• Offers a shortcode for printing the notice anywhere, including inside templates.
• Ships a tiny front-end stylesheet that only loads on singular views.
• Stateless: no options, no custom tables, nothing left behind on uninstall.

Installation

Option A - Install from the WordPress admin (recommended)

1. Download or clone this repository.
2. Compress the mornrain-reading-time folder itself into mornrain-reading-time.zip. The archive must contain the plugin folder, not the repository root.
3. Go to Plugins > Add New > Upload Plugin, choose the ZIP, click Install Now, then Activate.

Option B - Copy the folder over FTP / SSH

1. Copy the whole mornrain-reading-time folder into wp-content/plugins/.
2. Go to Plugins and activate MornRain Reading Time.

Option C - Git clone (developer workflow)

cd wp-content/plugins
git clone https://github.com/mornrain-lin/mornrain-reading-time.git

Configuration

There is no settings screen; behaviour is controlled with filters so the plugin stays configuration-free.

Example - move the notice to the bottom of the post and speed up the estimate:

add_filter( 'mornrain_reading_time_position', fn() => 'after' );
add_filter( 'mornrain_reading_time_words_per_minute', fn() => 250 );

Hooks reference

Public helper functions:

Shortcode: [mornrain_reading_time], or [mornrain_reading_time post_id="12"].

File structure

mornrain-reading-time/                    # MornRain Reading Time 插件根目录：阅读时长提示
|-- .github/                              # GitHub 仓库配置目录
|   `-- workflows/                        # GitHub Actions 工作流目录
|       `-- build.yml                     # CI 工作流：在 PHP 8.1–8.3 上 lint、跑 PHPUnit 并打包 ZIP 构件
|-- assets/                               # 前端静态资源目录
|   `-- css/                              # 样式资源目录
|       `-- reading-time.css              # 前台样式：阅读时长提示条外观，仅单篇视图加载
|-- includes/                             # 插件 PHP 源码目录
|   |-- class-mornrain-reading-time.php   # 主类：在 the_content 插入阅读时长提示并防止重复输出
|   |-- functions-reading-time.php        # 辅助函数：拉丁词与 CJK 字符分别计数、按速度估算分钟数
|   `-- shortcode-reading-time.php        # 短码：实现 [mornrain_reading_time]
|-- tests/                                # PHPUnit 测试目录
|   |-- ScaffoldTest.php                  # 脚手架冒烟测试：断言 README、LICENSE、composer.json 存在
|   `-- bootstrap.php                     # PHPUnit 引导文件：存在时才加载 Composer 自动加载器
|-- mornrain-reading-time.php             # 插件入口：声明插件头并加载 includes
|-- composer.json                         # Composer 元数据与 lint/test 脚本
|-- LICENSE                               # GPL-2.0-or-later 许可证全文
|-- phpunit.xml.dist                      # PHPUnit 配置，扫描 tests 目录
|-- README.md                             # 插件说明文档
|-- readme.txt                            # WordPress 插件目录要求的 readme.txt
`-- uninstall.php                         # 卸载脚本：插件无持久数据，仅作占位说明

Development and quality checks

composer install
composer validate
composer lint   # runs php -l over every PHP file
composer test   # runs PHPUnit

Coding style follows the WordPress Coding Standards: tab indentation, Yoda conditions, prefixed global functions, nonce and capability checks on every write path, and escaped output everywhere.

Continuous integration lives in .github/workflows/build.yml. It runs on every push and pull request across PHP 8.1, 8.2 and 8.3: composer install, php -l linting, PHPUnit, and finally packages a release ZIP as a build artifact.

Frequently asked questions

Which post types are annotated?

Any public post type rendered on a singular view through the_content. Use the mornrain_reading_time_enabled filter to narrow it down.

Can I move the notice below the content?

Yes. Return after from the mornrain_reading_time_position filter.

Does it work with Chinese, Japanese and Korean content?

Yes. CJK ideographs and kana are counted per character, which keeps the estimate realistic for those scripts.

Will it appear twice if a page builder renders the content twice?

No. The plugin records which posts it has already annotated during the request and skips any repeat.

Does it leave data behind when deleted?

No. There is no options row, no custom table and no transient. uninstall.php documents that explicitly.

Changelog

1.0.0

• Initial public release.

License

Released under the GNU General Public License v2 or later. See LICENSE for the full text.