New sniff for adding missing return void comments

classes/controllers/FrmAddonsController.php

@@ -1133,6 +1133,8 @@ function ( $plugin ) {
 	 * @since 3.04.02
 	 *
 	 * @param string $installed The plugin folder name with file name.
+	 *
+	 * @return void
 	 */
 	protected static function maybe_activate_addon( $installed ) {
 		self::ajax_activate_addon();

classes/controllers/FrmFormActionsController.php

@@ -20,6 +20,8 @@ class FrmFormActionsController {
 	 * post_content: json settings
 	 * menu_order: form id
 	 * post_excerpt: action type
+	 *
+	 * @return void
 	 */
 	public static function register_post_types() {
 		register_post_type(
@@ -112,6 +114,8 @@ private static function maybe_unset_highrise( $action_classes ) {
 	 * @since 4.0
 	 *
 	 * @param array $values
+	 *
+	 * @return void
 	 */
 	public static function email_settings( $values ) {
 		$form            = FrmForm::getOne( $values['id'] );
@@ -263,6 +267,8 @@ private static function active_actions( $action_controls ) {
 	 *
 	 * @param object $action_control
 	 * @param array  $allowed
+	 *
+	 * @return void
 	 */
 	public static function show_action_icon_link( $action_control, $allowed ) {
 		$data        = array();

classes/controllers/FrmFormsController.php

@@ -63,6 +63,8 @@ public static function register_widgets() {
 	 * Show a message about conditional logic
 	 *
 	 * @since 4.06.03
+	 *
+	 * @return void
 	 */
 	public static function logic_tip() {
 		$images_url    = FrmAppHelper::plugin_url() . '/images/';
@@ -824,6 +826,8 @@ public static function bulk_untrash( $ids ) {
 
 	/**
 	 * @since 3.06
+	 *
+	 * @return void
 	 */
 	public static function ajax_trash() {
 		FrmAppHelper::permission_check( 'frm_delete_forms' );
@@ -1901,6 +1905,8 @@ public static function form_classes( $form ) {
 	 * @since 5.0.03
 	 *
 	 * @param stdClass $form
+	 *
+	 * @return void
 	 */
 	public static function add_js_validate_form_to_global_vars( $form ) {
 		global $frm_vars;
@@ -2287,6 +2293,8 @@ public static function admin_bar_css() {
 
 	/**
 	 * @since 4.05.02
+	 *
+	 * @return void
 	 */
 	private static function move_menu_to_footer() {
 		$settings = FrmAppHelper::get_settings();
@@ -2322,6 +2330,8 @@ public static function admin_bar_configure() {
 
 	/**
 	 * @since 2.05.07
+	 *
+	 * @return void
 	 */
 	public static function add_menu_to_admin_bar() {
 		global $wp_admin_bar;
@@ -2690,6 +2700,8 @@ public static function maybe_trigger_redirect( $form, $params, $args ) {
 	 * @param object       $form        Form object.
 	 * @param array        $params      See {@see FrmFormsController::maybe_trigger_redirect()}.
 	 * @param array        $args        See {@see FrmFormsController::maybe_trigger_redirect()}.
+	 *
+	 * @return void
 	 */
 	public static function maybe_trigger_redirect_with_action( $conf_method, $form, $params, $args ) {
 		if ( is_array( $conf_method ) && 1 === count( $conf_method ) ) {
@@ -2743,6 +2755,8 @@ public static function trigger_redirect( $form, $params, $args ) {
 	 *     @type array  $fields               The array of fields.
 	 *     @type int    $force_delay_redirect Force to show the message before redirecting in case redirect method runs.
 	 * }
+	 *
+	 * @return void
 	 */
 	public static function run_success_action( $args ) {
 		global $frm_vars;
@@ -2921,6 +2935,8 @@ public static function run_on_submit_actions( $args ) {
 	 * @since 6.0
 	 *
 	 * @param array $args See {@see FrmFormsController::run_success_action()}.
+	 *
+	 * @return void
 	 */
 	public static function run_multi_on_submit_actions( $args ) {
 		$redirect_action = null;
@@ -2951,6 +2967,8 @@ public static function run_multi_on_submit_actions( $args ) {
 	 *
 	 * @param array  $args   See {@see FrmFormsController::run_success_action()}.
 	 * @param object $action On Submit action object.
+	 *
+	 * @return void
 	 */
 	public static function run_single_on_submit_action( $args, $action ) {
 		$new_args = self::get_run_success_action_args( $args, $action );
@@ -3072,6 +3090,8 @@ private static function redirect_after_submit( $args ) {
 	 *
 	 * @param string $success_url Success URL.
 	 * @param array  $args        See {@see FrmFormsController::redirect_after_submit()}.
+	 *
+	 * @return void
 	 */
 	private static function print_open_in_new_tab_js_with_fallback_handler( $success_url, $args ) {
 		echo '<script>var newTab = window.open("' . esc_url_raw( $success_url ) . '", "_blank");';
@@ -3146,6 +3166,8 @@ private static function get_ajax_redirect_response_data( $args ) {
 	 * @since 6.0
 	 *
 	 * @param array $args See {@see FrmFormsController::run_success_action()}.
+	 *
+	 * @return void
 	 */
 	private static function redirect_after_submit_using_js( $args ) {
 		$success_msg  = $args['form']->options['redirect_delay_msg'];

classes/controllers/FrmStylesController.php

@@ -159,6 +159,8 @@ private static function maybe_hook_into_global_settings_save() {
 			'frm_update_settings',
 			/**
 			 * Update the form data on the "Manage Styles" tab after global settings are saved.
+			  *
+			  * @return void
 			 */
 			function () {
 				self::manage_styles();

classes/helpers/FrmAppHelper.php

@@ -980,6 +980,8 @@ public static function strip_most_html( $value ) {
 	 * @since 4.0.04
 	 *
 	 * @param mixed $value Value to decode, passed by reference.
+	 *
+	 * @return void
 	 */
 	public static function decode_specialchars( &$value ) {
 		if ( is_array( $value ) ) {
@@ -1917,6 +1919,8 @@ class="frm_autocomplete_value_input"
 	 * @since 6.21
 	 *
 	 * @param array $args Args. See the method for details.
+	 *
+	 * @return void
 	 */
 	public static function maybe_autocomplete_options( $args ) {
 		$defaults = array(
@@ -2013,6 +2017,8 @@ private static function get_dropdown_value_and_label_from_option( $option, $key,
 	 * @param array  $args
 	 * @param string $page_id Deprecated.
 	 * @param bool   $truncate Deprecated.
+	 *
+	 * @return void
 	 */
 	public static function wp_pages_dropdown( $args = array(), $page_id = '', $truncate = false ) {
 		self::prep_page_dropdown_params( $page_id, $truncate, $args );
@@ -2153,6 +2159,8 @@ private static function is_full_screen_view_builder_page() {
 	 * @param string       $field_name
 	 * @param array|string $capability
 	 * @param string       $multiple 'single' and 'multiple'.
+	 *
+	 * @return void
 	 */
 	public static function wp_roles_dropdown( $field_name, $capability, $multiple = 'single' ) {
 		?>
@@ -2169,6 +2177,8 @@ class="frm_multiselect">
 	 *
 	 * @param array|string $selected
 	 * @param string       $current
+	 *
+	 * @return void
 	 */
 	private static function selected( $selected, $current ) {
 		if ( is_callable( 'FrmProAppHelper::selected' ) ) {
@@ -2180,6 +2190,8 @@ private static function selected( $selected, $current ) {
 
 	/**
 	 * @param array|string $capability
+	 *
+	 * @return void
 	 */
 	public static function roles_options( $capability ) {
 		global $frm_vars;
@@ -4230,6 +4242,8 @@ public static function get_menu_icon_class() {
 	 *     @type string  $classes     Custom CSS classes for the wrapper element.
 	 *     @type array   $input_attrs Attributes of value input.
 	 * }
+	 *
+	 * @return void
 	 */
 	public static function images_dropdown( $args ) {
 		$args            = self::fill_default_images_dropdown_args( $args );
@@ -4651,6 +4665,8 @@ public static function ctype_xdigit( $text ) {
 	 * Set the current screen to avoid undefined notices.
 	 *
 	 * @since 5.2.01
+	 *
+	 * @return void
 	 */
 	public static function set_current_screen_and_hook_suffix() {
 		global $hook_suffix;
@@ -4669,6 +4685,8 @@ public static function set_current_screen_and_hook_suffix() {
 	 * @since 5.2.02
 	 *
 	 * @param string $text Text in the pill. Default is NEW.
+	 *
+	 * @return void
 	 */
 	public static function show_pill_text( $text = null ) {
 		if ( null === $text ) {

classes/helpers/FrmListHelper.php

@@ -264,6 +264,8 @@ public function has_items() {
 	 * Message to be displayed when there are no items
 	 *
 	 * @since 2.0.18
+	 *
+	 * @return void
 	 */
 	public function no_items() {
 		esc_html_e( 'No items found.', 'formidable' );
@@ -525,6 +527,8 @@ protected function row_actions( $actions, $always_visible = false ) {
 	 * @since 2.0.18
 	 *
 	 * @param string $current_mode
+	 *
+	 * @return void
 	 */
 	protected function view_switcher( $current_mode ) {
 		?>
@@ -1178,6 +1182,8 @@ protected function has_min_items( $limit = 5 ) {
 	 * @since 2.0.18
 	 *
 	 * @param string $which
+	 *
+	 * @return void
 	 */
 	protected function extra_tablenav( $which ) {
 	}
@@ -1186,6 +1192,8 @@ protected function extra_tablenav( $which ) {
 	 * Generate the tbody element for the list table.
 	 *
 	 * @since 2.0.18
+	 *
+	 * @return void
 	 */
 	public function display_rows_or_placeholder() {
 		if ( $this->has_items() ) {
@@ -1216,6 +1224,8 @@ public function single_row( $item ) {
 	 * @since 2.0.18
 	 *
 	 * @param object $item The current item.
+	 *
+	 * @return void
 	 */
 	protected function single_row_columns( $item ) {
 		list( $columns, $hidden,, $primary ) = $this->get_column_info();

classes/helpers/FrmXMLHelper.php

@@ -417,6 +417,8 @@ private static function delete_removed_fields( $form_fields ) {
 	 * @since 2.0.16
 	 *
 	 * @param array $forms
+	 *
+	 * @return void
 	 */
 	private static function put_child_forms_first( &$forms ) {
 		$child_forms   = array();
@@ -443,6 +445,8 @@ private static function put_child_forms_first( &$forms ) {
 	 * @param int   $form_id
 	 * @param int   $parent_form_id
 	 * @param array $child_forms
+	 *
+	 * @return void
 	 */
 	private static function track_imported_child_forms( $form_id, $parent_form_id, &$child_forms ) {
 		if ( $parent_form_id ) {
@@ -458,6 +462,8 @@ private static function track_imported_child_forms( $form_id, $parent_form_id, &
 	 *
 	 * @param array $imported_forms
 	 * @param array $child_forms
+	 *
+	 * @return void
 	 */
 	private static function maybe_update_child_form_parent_id( $imported_forms, $child_forms ) {
 		foreach ( $child_forms as $child_form_id => $old_parent_form_id ) {
@@ -482,6 +488,8 @@ private static function maybe_update_child_form_parent_id( $imported_forms, $chi
 	 * @param object           $this_form
 	 * @param array            $form_fields
 	 * @param array            $imported
+	 *
+	 * @return void
 	 */
 	private static function import_xml_fields( $xml_fields, $form_id, $this_form, &$form_fields, &$imported ) {
 		$in_section                = 0;
@@ -1286,6 +1294,8 @@ private static function populate_post( &$post, $item, $imported ) {
 	 * @param array    $post
 	 * @param stdClass $meta
 	 * @param array    $imported
+	 *
+	 * @return void
 	 */
 	private static function populate_postmeta( &$post, $meta, $imported ) { // phpcs:ignore SlevomatCodingStandard.Complexity.Cognitive.ComplexityTooHigh, Generic.Metrics.CyclomaticComplexity.MaxExceeded, SlevomatCodingStandard.Files.LineLength.LineTooLong
 		global $frm_duplicate_ids;
@@ -1386,6 +1396,8 @@ private static function populate_layout( &$post, $layout ) {
 	 *
 	 * @param array  $post By reference.
 	 * @param object $item The XML object data.
+	 *
+	 * @return void
 	 */
 	private static function populate_taxonomies( &$post, $item ) {
 		foreach ( $item->category as $c ) {
@@ -1487,6 +1499,8 @@ private static function update_postmeta( &$post, $post_id ) {
 	/**
 	 * @param array $post
 	 * @param int   $post_id
+	 *
+	 * @return void
 	 */
 	private static function update_layout( &$post, $post_id ) {
 		if ( is_callable( 'FrmViewsLayout::maybe_create_layouts_for_view' ) ) {

classes/models/FrmInstallerSkin.php

@@ -51,13 +51,17 @@ public function set_result( $result ) {
 	 * been performed or not.
 	 *
 	 * @since 3.04.02
+	 *
+	 * @return void
 	 */
 	public function header() {}
 
 	/**
 	 * Empty out the footer of its HTML contents.
 	 *
 	 * @since 3.04.02
+	 *
+	 * @return void
 	 */
 	public function footer() {}
 
@@ -100,6 +104,8 @@ public function error( $errors ) {
 	 *
 	 * @param string $string The feedback string.
 	 * @param mixed  ...$args Optional text replacements.
+	 *
+	 * @return void
 	 */
 	public function feedback( $string, ...$args ) {}
 }

classes/models/FrmMigrate.php

@@ -784,6 +784,8 @@ private function convert_character_to_px( &$size ) {
 
 	/**
 	 * Migrate post and email notification settings into actions
+	 *
+	 * @return void
 	 */
 	private function migrate_to_16() {
 		$forms = FrmDb::get_results( $this->forms, array(), 'id, options, is_template, default_template' );

classes/models/fields/FrmFieldCheckbox.php

@@ -128,6 +128,8 @@ protected function prepare_import_value( $value, $atts ) {
 	 *
 	 * @param array $shortcode_atts
 	 * @param array $args
+	 *
+	 * @return void
 	 */
 	public function set_aria_invalid_error( &$shortcode_atts, $args ) {
 		unset( $shortcode_atts['aria-invalid'] );

classes/models/fields/FrmFieldRadio.php

@@ -129,6 +129,8 @@ protected function show_readonly_hidden() {
 	 *
 	 * @param array $shortcode_atts
 	 * @param array $args
+	 *
+	 * @return void
 	 */
 	public function set_aria_invalid_error( &$shortcode_atts, $args ) {
 		unset( $shortcode_atts['aria-invalid'] );

classes/models/fields/FrmFieldSubmit.php

@@ -78,6 +78,8 @@ protected function include_form_builder_file() {
 
 	/**
 	 * Shows label on form builder.
+	 *
+	 * @return void
 	 */
 	public function show_label_on_form_builder() {
 		// Do nothing.