Download the PHP package lukeyouell/craft-readtime without Composer
On this page you can find all versions of the php package lukeyouell/craft-readtime. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download lukeyouell/craft-readtime
More information about lukeyouell/craft-readtime
Files in lukeyouell/craft-readtime
Package craft-readtime
Short Description Calculate the estimated read time for content.
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package craft-readtime
Read Time
Calculate the estimated read time for content.
Installation
Requirements
This plugin requires Craft CMS 5.0.0 or later and PHP 8.2 or later.
Using Craft 4? Use the 2.x line, which is the Craft 4 release of this plugin.
Plugin Store
Log into your control panel and click on 'Plugin Store'. Search for 'Read Time'.
Composer
-
Open your terminal and go to your Craft project:
-
Then tell Composer to load the plugin:
- In the Control Panel, go to Settings → Plugins and click the "Install" button for Read Time.
Usage
Using the Filter
The |readTime filter returns a TimeModel of how long it takes the average user to read the provided content. The value provided can be a string or an array of values.
Seconds are included by default, but can be disabled by using |readTime(false) — this only affects the human time format.
Using the Function
The readTime() function returns a TimeModel for the whole entry (based on its field layout) or for a block field passed directly.
Seconds are included by default, but can be disabled by passing false as a second parameter — this only affects the human time format.
Using GraphQL
A readTime field is available on entry types in Craft's GraphQL API. It returns a ReadTime object type mirroring the TimeModel, so GraphQL and Twig report the same read time for a given entry.
| Field | Returns |
|---|---|
seconds |
The total number of seconds. |
minutes |
The total number of whole minutes. |
hours |
The total number of whole hours. |
humanReadable |
The human-readable duration. |
Seconds are included in humanReadable by default. Pass showSeconds: false to the readTime field to omit them — this only affects humanReadable:
The field resolves on demand from the same read time service used by the Twig function and filter, so it counts all supported field types (Matrix, Neo, Vizy, CKEditor). Read time is computed by walking an entry's field layout, so selecting readTime across a large entry query computes it per entry — request it only where you need it.
Supported Field Types
When you pass an entry to readTime(), the plugin walks its field layout and counts the content of each field, recursing into nested-block fields:
| Field type | Notes |
|---|---|
| Plain text / rich text (e.g. Redactor, Plain Text) | Counted directly. |
| Matrix (native) | On Craft 5, Matrix blocks are entrified — each block is an Entry element. Their nested fields are walked recursively. |
Neo (spicyweb/craft-neo) |
Each Neo block's fields are walked recursively. |
Vizy (verbb/vizy) |
Rich-text content is counted and Vizy blocks' nested fields are walked recursively. |
CKEditor (craft/ckeditor) |
The editor's rich-text content is counted, plus the content of any entries embedded inside the field. |
Neo, Vizy, and CKEditor are treated as optional, soft dependencies — the plugin loads and computes read time fine on sites that don't have them installed.
Super Table is no longer supported. It does not exist for Craft 5, so it has been removed from the Craft 5 code path. Super Table support remains in the Craft 4 (2.x) line.
TimeModel
Both the filter and the function return a TimeModel. Output it directly for a human-readable duration, or read one of its properties for a specific value:
| Property | Returns |
|---|---|
time / time.human |
The human-readable duration. |
time.seconds |
The total number of seconds. |
time.minutes |
The total number of whole minutes. |
time.hours |
The total number of whole hours. |
You can also format the duration as a DateInterval by passing a format string to interval():
Settings
| Setting | Default | Description |
|---|---|---|
wordsPerMinute |
200 |
The average reading speed, in words per minute, used to calculate the read time. |
outputLocale |
(empty) | The language used for the human-readable string. Empty follows the current application language; site formats each element in its own site's language; a locale ID (e.g. de-DE) forces one language everywhere. See Output Locale below. Only the human-readable string is affected. |
minimumReadTime |
0 |
Minimum read time, in whole minutes. When greater than 0, read times are rounded up to at least this many minutes, so sub-minute (and empty) content displays as e.g. "1 minute" instead of "less than a minute". 0 keeps the default behaviour. |
The minimum is applied at the source, so it is reflected consistently everywhere — time.human, time.seconds, time.minutes, time.hours, the readTime() function, and the |readTime filter all agree, as does any other consumer of the returned TimeModel.
Output Locale
By default the human-readable string follows the current application language, which depends on context: a logged-in user's preferred language in the Control Panel, the requested site's language on the front end, and the system/default language in console commands (e.g. php craft resave/entries). That means content pre-parsed into a custom field can end up in a different language depending on where it was saved.
The outputLocale setting lets you pin the language of the human-readable string so it stays consistent. It is a single setting with three modes:
| Value | Behaviour |
|---|---|
(empty) / null |
Current language (default). The output follows the active application language — the existing behaviour, unchanged. |
site |
Content's site language. The output is formatted in the language of the site the content belongs to. Recommended for multi-site installs: each site's content formats in its own language, including under resave/entries. On the |readTime filter (which has no element), this falls back to the current site's language. |
a locale ID, e.g. de-DE |
Force that locale everywhere. Useful for single-site installs, or anyone who wants uniform output across all sites. |
This affects only the human-readable string (time / time.human, and the GraphQL human-readable field). Numeric values (time.seconds, time.minutes, time.hours) are locale-independent and never change.
In the Control Panel the dropdown lists Current language, Content's site language, and your configured site languages. Via the config file you can also set any locale ID Craft recognises, even if it isn't one of your site languages.
Overriding Plugin Settings
These settings can be changed in the plugin settings in the Control Panel, or overridden with a config file.
If you create a config file in your config folder called read-time.php, you can override the plugin's settings in the Control Panel. Since that config file is fully multi-environment aware, this is a handy way to have different settings across multiple environments. An example is included at config/read-time.php.
Found a Bug? Need Support?
Please open an issue describing what's going wrong.
