How to Create A Custom Form In October CMS?

11 minutes read

To create a custom form in October CMS, you can follow these steps:

  1. First, you need to create a new plugin in October CMS. Plugins are used to extend the functionality of the CMS.
  2. Inside your plugin, create a new file for your form. This can be done in the "components" directory of your plugin.
  3. Define your form component by extending the Cms\Classes\ComponentBase class. This class provides the necessary functionality to create components in October CMS.
  4. Customize the properties and methods of your form component based on your requirements. You can add form fields, validation rules, and actions.
  5. The form fields can be added using the properties property of the component. You can define each field as a public property with attributes like label, type, validation rules, etc.
  6. If you want to display the form in a front-end page, you need to define a onRun() method in your component. This method will be called when the component is loaded on a page. Inside this method, you can perform any necessary tasks, like retrieving data, before rendering the form.
  7. Render the form markup in the component's default.htm or another layout file. You can use HTML and form helpers provided by the CMS to generate the necessary form structure. Bind the form fields to the component's properties using the {{ form_field() }} syntax.
  8. Handle form submissions by defining a onSubmit() method in your component. This method will be called when the form is submitted. Inside this method, you can perform any necessary tasks, like saving data to the database or sending emails.

These steps will help you create a custom form in October CMS. Remember to make use of the CMS's documentation and community resources for more detailed information and examples.

Best October CMS Hosting Providers in 2024


Rating is 5 out of 5


  • Ultra-fast Intel Core
  • High Performance and Cheap Cloud Dedicated Servers
  • 1 click install Wordpress
  • Low Price and High Quality
Digital Ocean

Rating is 5 out of 5

Digital Ocean

  • Active Digital Community
  • Simple Control Panel
  • Starting from 5$ per month

Rating is 5 out of 5



Rating is 5 out of 5


What is the purpose of form spam protection in October CMS?

The purpose of form spam protection in October CMS is to prevent unwanted or malicious spam submissions on forms. It helps to improve the overall security and user experience of websites built with October CMS by filtering out automated or unsolicited form submissions. The form spam protection feature typically includes techniques such as CAPTCHA (Completely Automated Public Turing test to tell Computers and Humans Apart) or honeypot fields to detect and differentiate between human users and automated bots.

What is the role of server-side form validation?

Server-side form validation is the process of validating user input on the server before processing it. While client-side validation (done using JavaScript) ensures a better user experience by providing immediate feedback, it is crucial to perform server-side validation for several reasons:

  1. Security: Client-side validation can be easily bypassed by attackers or malicious users. Thus, server-side validation acts as an additional layer of security to prevent malicious data or code from being submitted.
  2. Reliability: Client-side validation can be disabled or modified by users, or it may not be supported by all browsers. Server-side validation ensures that all incoming data is validated, regardless of the client.
  3. Data consistency: Server-side validation ensures that the submitted data meets the required format, length, or any other criteria set by the application. This helps in maintaining data integrity and consistency in the backend.
  4. Business rules enforcement: Server-side validation allows you to apply complex business rules that cannot be easily implemented on the client-side. It ensures that the submitted data adheres to these business rules and constraints.
  5. Cross-browser and device compatibility: Different browsers and devices may have varying levels of support for client-side validation. Server-side validation guarantees a consistent validation process across all platforms.
  6. Accessibility: Server-side validation ensures that users who may have JavaScript disabled or use assistive technologies can still submit valid data and receive appropriate feedback.

Overall, server-side form validation is essential to maintain the security, reliability, consistency, and usability of a web application. It helps in preventing data corruption, ensuring data integrity, and protecting the application from malicious submissions.

How to use conditional logic in a custom form in October CMS?

To use conditional logic in a custom form in October CMS, you can follow these steps:

  1. Create a custom form component in the October CMS backend or using the Builder plugin. This will generate a PHP file for your custom form.
  2. Inside your custom form component, you will find a onRun() method. This method runs when the form is displayed. You can use this method to define any initial values or conditions for your form.
  3. Add form fields to your custom form component using the addFields method. For example, you can use the text field type: $form->addFields([ 'name' => [ 'label' => 'Name', 'type' => 'text', ], // ... ]);
  4. Define your conditional logic by adding a trigger and one or more conditions to your form fields. The trigger field controls when the conditional logic is applied, and the conditions specify the conditions that need to be met. $form->addFields([ 'name' => [ 'label' => 'Name', 'type' => 'text', ], 'age' => [ 'label' => 'Age', 'type' => 'text', 'trigger' => [ 'action' => 'show', 'field' => 'name', 'condition' => 'value[John]', ], ], // ... ]); In this example, the age field will only be shown if the name field has a value of "John".
  5. You can use various operators and conditions in the condition attribute, such as value[], checked, notchecked, empty, notempty, etc. 'condition' => 'value[John]', // Equals 'condition' => 'value[not John]', // Not equals 'condition' => 'checked[1]', // Checkbox checked 'condition' => 'notchecked', // Checkbox not checked 'condition' => 'empty', // Field is empty 'condition' => 'notempty', // Field is not empty // ...
  6. You can also nest conditions to create more complex logic. For example, you can use group fields to create nested conditions: $form->addFields([ 'name' => [ 'label' => 'Name', 'type' => 'text', ], 'age' => [ 'label' => 'Age', 'type' => 'text', 'trigger' => [ 'action' => 'show', 'field' => 'name', 'condition' => 'value[John]', ], 'conditions' => [ 'name' => 'group_name', 'fields' => [ 'name' => [ 'condition' => 'checked', ], ], ], ], // ... ]); In this example, the age field will only be shown if the name field has a value of "John" and the name field itself is checked.
  7. Save your form component and use it in your October CMS front-end pages or layouts. The conditional logic will now be applied to the form fields based on the defined triggers and conditions.

By implementing conditional logic in your custom forms, you can dynamically show or hide form fields based on specific conditions, providing a more interactive and personalized user experience.

How to create a multi-step form in October CMS?

To create a multi-step form in October CMS, you can follow these steps:

Step 1: Create a plugin First, create a new plugin in October CMS. You can use the artisan command php artisan create:plugin PluginName to generate the plugin scaffold.

Step 2: Create the form components Inside your plugin directory, create a new directory called components. Create two new components in this directory, one for each step of the form. You can use the artisan command php artisan create:component PluginName ComponentName to generate the component scaffold.

Step 3: Define the form fields Inside each of the form component classes, define the form fields using the defineProperties() method. Each field should have a unique name and a label.

Step 4: Handle the form submission In each form component class, add a onSubmit() method to handle the form submission. You can use the data parameter to access the submitted form values. If the form has multiple steps, you can store the values in session variables.

Step 5: Create the main form component Create a new component in the components directory called FormContainer. This component will be responsible for rendering and managing the multi-step form. In this component, define a property to keep track of the current step and render the appropriate form component based on the current step.

Step 6: Add navigation buttons Inside the FormContainer component's template file, add navigation buttons to allow the user to move between the form steps. You can use a condition to render the appropriate buttons based on the current step.

Step 7: Implement the navigation logic Inside the FormContainer component's PHP file, add methods to handle the navigation logic. These methods should update the current step property based on the user's navigation actions.

Step 8: Render the multi-step form Add the FormContainer component to a CMS page or another component's template file to render the multi-step form.

Step 9: Customize the form styling and validation Customize the form styling and validation by adding CSS styles and validation rules to the form components and the form container component.

That's it! You have now created a multi-step form in October CMS. Each step of the form will be rendered and handled by separate component classes, and the user can navigate between the steps using navigation buttons.

What is a custom form in web development?

A custom form in web development refers to a form that has been specifically designed and built to meet the unique requirements and preferences of a particular website or application.

In web development, forms are used to collect user input such as contact information, registration details, or survey responses. While basic forms can be created using HTML, CSS, and JavaScript, a custom form may involve more complex functionalities or design elements tailored to the specific needs of the website or application.

Custom forms can include various features such as validation rules, conditional logic, multi-step layouts, dynamic fields, and integrations with databases or third-party services. Customization can also involve styling the form to match the website's branding and user interface, making it visually cohesive with the overall design.

Developers typically use programming languages like PHP, JavaScript, or frameworks like React or Angular to build custom forms and handle form submissions. By creating custom forms, developers have more flexibility and control in meeting the specific requirements and goals of the website or application.

Facebook Twitter LinkedIn Telegram Whatsapp Pocket

Related Posts:

In October CMS, you can use cron jobs to automate repetitive tasks or scheduled actions. Cron jobs are widely used in web development to run scripts or commands at specific intervals.To use cron jobs in October CMS, you need to follow these steps:Create a new ...
To create a blog in October CMS, you need to follow these steps:Install October CMS: Download and install the October CMS on your server. Ensure you have a compatible server environment (e.g., PHP, MySQL). Log in to the Backend: Access the backend of your Octo...
To install October CMS, follow these steps:First, you need to have a web server with PHP and MySQL installed. Make sure that your server meets the system requirements for October CMS.Download the latest version of October CMS from their official website.Extrac...