Submission_Modifier_Access_Control_Interface

Interface for an access control that modifies submission data.

Description

Source

File: src/modules/access-controls/submission-modifier-access-control-interface.php

interface Submission_Modifier_Access_Control_Interface {

	/**
	 * Sets additional data for a submission when it is created.
	 *
	 * @since 1.0.0
	 *
	 * @param Submission $submission New submission object.
	 * @param Form       $form       Form object the submission belongs to.
	 * @param array      $data       Submission POST data.
	 */
	public function set_submission_data( $submission, $form, $data );
}

Changelog

Changelog
Version Description
1.0.0 Introduced.

Methods

  • bootstrap — Bootstraps the submodule by setting properties.
  • can_access — Determines whether the current user can access a specific form or submission.
  • enabled — Checks whether the access control is enabled for a specific form.
  • get_default_already_submitted_message — Returns the default message to display when the user is not logged in.
  • get_meta_fields — Returns the available meta fields for the submodule.
  • set_submission_data — Sets additional data for a submission when it is created.