docs:hooks

[sapayth]

documentation for a list of hooks created across WP user frontend plugin

Summary by CodeRabbit

• Documentation

  • Added comprehensive documentation for all action hooks in the WP User Frontend plugin.
  • Added detailed documentation for all filter hooks, including usage and parameters.
  • Introduced a centralized list of all action and filter hooks with documentation status for easy reference.

• Chores

  • Restored a file to the ignore list to prevent it from being tracked by version control.

[coderabbitai]

Walkthrough

This update introduces comprehensive documentation for the WP User Frontend plugin hooks, including detailed references for all action and filter hooks and a master list of available hooks. Additionally, a previously ignored test image file is re-added to the .gitignore configuration.

Changes

Files/Paths	Change Summary
docs/hooks/actions.md	Added detailed documentation for all action hooks in the WP User Frontend plugin.
docs/hooks/filters.md	Added detailed documentation for all filter hooks in the WP User Frontend plugin.
docs/hooks/list.md	Added a master list of all action and filter hooks, including documentation status.
.gitignore	Re-added tests/e2e/plugins-page-wpuf-lite-check.png to the ignore list.

Suggested labels

Ready to Merge

Poem

In burrows deep, the docs now gleam,
Hooks and filters, a dev’s dream!
Lists and guides for all to see,
Custom code with clarity.
And with a hop, a file ignored—
The frontend rabbit’s knowledge stored!
🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a1833d4 and f79006a.

📒 Files selected for processing (1)

• docs/hooks/list.md (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• docs/hooks/list.md

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

docs/hooks/list.md (1)

155-159: Note section contradicts the table

The note claims “All hooks are marked as No in the documented column initially”, yet every entry above is currently flagged Yes (except the two Appsero filters).
Either update the note or switch the undocumented hooks back to “No” to avoid misleading readers.

docs/hooks/actions.md (1)

891-898: Inconsistent capitalisation – verify actual hook spelling

WPUF_multidropdown_field_after_label is capitalised, whereas WordPress convention (and WP-UF source) uses lowercase (wpuf_multidropdown_field_after_label).
Confirm the exact hook name and normalise – otherwise sample code that copies from the docs will silently fail.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c389f9f and a1833d4.

📒 Files selected for processing (4)

• .gitignore (1 hunks)
• docs/hooks/actions.md (1 hunks)
• docs/hooks/filters.md (1 hunks)
• docs/hooks/list.md (1 hunks)

🔇 Additional comments (4)

.gitignore (1)

35-35: Addition looks good – keeps binary test artefact out of the repo

Nothing else to flag.

docs/hooks/list.md (1)

53-57: Potential duplicate / conflicting hook names

Rows 54 – 57 list both the underscore and the hyphen variants of the same “form-builder settings tabs” hooks (wpuf_form_builder_settings_tabs_{form_type} vs wpuf-form-builder-settings-tabs-{form_type}, etc.).
Please check the source-code calls (do_action) – only one naming style is usually present in core. Keeping both will confuse users and inflate the tally.

docs/hooks/actions.md (1)

690-740: Same hook group repeated with two naming schemes

The block for the form-builder hooks includes both:

• wpuf_form_builder_settings_tabs_{form_type} (underscores)
• wpuf-form-builder-settings-tabs-{form_type} (hyphens)

Only one form actually exists in code. Having both here introduces duplication and will break copy-paste usage for developers. Please grep the codebase and keep the authoritative spelling.

docs/hooks/filters.md (1)

19-24: Missing documentation for filters marked “No” in hook list

docs/hooks/list.md flags appsero_endpoint and appsero_is_local as undocumented (“No”). They are not present in this file, so the status is correct – but the list will remain inconsistent until you add corresponding sections or flip the status to “Yes” only after docs land.