Skip to content

Conversation

EmiFunes91
Copy link
Contributor

This pull request addresses issue #228 by improving the clarity and structure of the register() and boot() method documentation in the Plugin registration guide.

Summary of changes:

  • Refined the explanation of when and how each method is executed.
  • Provided real-world examples aligned with best practices in plugin development.
  • Clarified the purpose of each method and their place in the CMS boot cycle.
  • Emphasized common pitfalls and the role of $elevated = true in special contexts.
  • Preserved the overall format and tone of the documentation to ensure consistency.

Purpose:

The goal of this update is to offer a clearer understanding of two core lifecycle methods for plugin developers—especially those new to Winter CMS. These clarifications aim to reduce misimplementation and make the documentation more actionable.

Let me know if anything should be revised further. I’m glad to support this project.

@LukeTowers
Copy link
Member

@EmiFunes91 thanks for your interest in contributing to the Winter CMS documentation. Please review the errors reported by the linter.

@EmiFunes91 EmiFunes91 force-pushed the fix/explain-register-boot branch from 01cd35d to 4b53a73 Compare May 15, 2025 02:57
@EmiFunes91
Copy link
Contributor Author

Thanks, @LukeTowers.
I've reviewed the linter feedback and just pushed the required fixes.
Let me know if there's anything else you'd like me to adjust — happy to help.

@EmiFunes91
Copy link
Contributor Author

Hi Luke, just following up to see if this could be reviewed when possible.

The goal here was to clarify the plugin lifecycle methods with a more structured explanation and practical examples, aligned with the scope of Issue #228. I'm happy to make any adjustments if needed to better fit the style or direction of the docs.

Thanks again for your time and for the great work you do maintaining WinterCMS.

@LukeTowers LukeTowers merged commit abe1ae3 into wintercms:develop Jun 2, 2025
1 check passed
@EmiFunes91 EmiFunes91 deleted the fix/explain-register-boot branch June 2, 2025 04:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants