Users define their editorial rules in YAML (see Settings -> Secretary) according to a number of built-in rule functions. For example, Secretary can show a warning if you’ve forgotten to set a Featured Image for your post, by adding the
featured-image rule to your YAML config.
Secretary comes with a number of rules out of the box, but you can write your own custom plugins for Secretary by calling
SecretaryRules::register. See example at https://github.com/ChrisBAshton/secretary-rule-gallery-at-top, and API documentation at https://github.com/ChrisBAshton/secretary.
If you spot any issues, or want to know how to contribute, please visit https://github.com/ChrisBAshton/secretary.
Please note that I have open-sourced this plugin to give back to the community, and do not have much spare time to answer support queries, but I’ll help where I can.
- Install the plugin through the WordPress plugins screen directly
- Activate the plugin through the ‘Plugins’ screen in WordPress
- Use the Settings->Secretary screen to configure the plugin (you can see all available rule configs on the right hand side of the screen)
Example YAML config below:
categories: not: - Uncategorized not-only: - Featured featured-image: max-size: 100 format: jpg dimensions: width: 760 height: 350 excerpt: min-length: 30 max-length: 300 scheduled: publish-time: '15:00' links: internal: open-in-new-tab: false external: open-in-new-tab: true images: true html-checker: risky-html: - table - div - span - style - script
How do I know what rules are available?
Look at the right hand side of the screen under Settings -> Secretary.
I’m getting a `Config error: no such rule!`
If you see something like:
❌ foo Config error: no such rule!
…it means you have asked Secretary to apply a rule which does not exist. Check your spelling.
- Removes an accidentally committed internal-facing README file
- Removed unneeded ‘assets/’ directory
- Tested with Gutenberg
- Initial release