WS Form ability reference

What WS Form needs before these load

WS Form must be active, in either its LITE or PRO edition. Pro's manifest loads the module when the WS_Form_Form class or the WS_FORM_VERSION constant is present; there is no GoBuildWP version floor, and the vendor calls were checked against WS Form LITE 1.12.10. Access follows WS Form's own capabilities on top of GoBuildWP's run check: read_form to list and read forms, read_submission for submissions, and both edit_form and publish_form for the edit. With WS Form deactivated the module does not load and none of its calls are offered.

WS Form editions

free, pro

What a WS Form submission reveals to the agent

Submissions are filtered before they leave the site. Passwords, card data, uploads, signatures and any visitor IP WS Form recorded follow the form-entry-redaction rule that Pro hands to its form kits from includes/wppilot-kit-form-redaction.php, and come back as "[REDACTED]" with a reason. Email and phone answers are withheld every time. In any other free-text answer, email addresses and runs of digits and number separators holding seven or more digits are cut out and marked contact_in_text. Date, time and number fields are not scanned, and shorter runs such as years survive, but a long order number or a full date typed as free text is cut out too. Without that shared rule, every answer is withheld (no_redaction_rule).

Drafts, spam and trashed submissions are not listed. Email actions report a recipient_count, never the addresses, and redacted values stay readable to the owner under WS Form > Submissions.

Editor copy, published copy and the missing undo

WS Form spreads a form across its own tables (wp_wsf_form, wp_wsf_group, wp_wsf_section, wp_wsf_field and a _meta table for each) and serves visitors a JSON copy taken at publish time. An edit lands in the editor copy. wppilot/wsform-update-form republishes through db_publish() when the form was live and its checksum still matched published_checksum, because publishing would otherwise release someone else's pending edits too; in every other case publish_note explains that the owner needs to publish. With WS Form's publish_auto option on, WS Form publishes by itself.

Fields are addressed by numeric id. A field counts as answer-taking when WS Form's submit_save flag says so; buttons and text blocks can be relabelled but refuse a placeholder or required change with wsform_field_takes_no_answer. Rolling an edit back is not offered, because WS Form's one whole-form restore is a JSON import that recreates every field under a new id and drafts the form, which would detach past submissions stored as field_<id>. The response's previous block holds the old values for a manual revert.

Representative call sequence

This sequence describes the documented calls and checks to perform. It is not a recorded result from an installed WordPress site. Inspect returned errors and partial results, then verify the saved values and affected output before proceeding.

Make the Phone field on the quote form optional, then see how many enquiries arrived last week.

1. 01 wppilot/wsform-list-forms Finds the quote form's id and whether has_unpublished_changes is already set.
2. 02 wppilot/wsform-get-form Returns the fields in order with their numeric ids and required flags, so the Phone field can be named exactly.
3. 03 wppilot/wsform-update-form Sets required to false on that field, reads it back, and returns previous plus a publish_note saying whether visitors already see the change.
4. 04 wppilot/wsform-list-entries Lists last week's completed submissions with date_from and date_to in site time; the phone answers come back redacted.

Questions about WS Form