do_action_ref_array( ‘in_widget_form’, WP_Widget $widget, null $return, array $instance )

User Contributed Notes

1. Skip to note 2 content

   Razon 5 years ago

   You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note

   Add custom widget field end of the widgets control form.

   if ( ! function_exists( 'wpdocs_display_custom_field_in_widget_form' ) ) {
   
       add_action( 'in_widget_form', 'wpdocs_display_custom_field_in_widget_form', 10, 3 );
   
       /**
        * Append custom field end of the widgets control form
        * Fires at the end of the widget control form.
        */
       function wpdocs_display_custom_field_in_widget_form( $widget, $return, $instance ) {
           $column = isset( $instance['column'] ) ? $instance['column'] : '';
   
           ob_start();
           ?>
   
           <p>
               <label for="<?php echo esc_attr( $widget->get_field_id( 'itclan_bs_grid_class' ) ) ?>"><?php _e( 'Column Label', 'text_domain' ) ?>
                   <input class="widefat" value="<?php echo esc_attr( $column ) ?>" id="<?php echo esc_attr( $widget->get_field_id( 'column' ) ) ?>" name="<?php echo esc_attr( $widget->get_field_name( 'column' ) ) ?>" type="text" />
                   <small><?php _e( 'Some additional description.', 'text_domain' ) ?></small>
               </label>
           </p>
   
           <?php 
           echo ob_get_clean();
       }
   }

   Filter widget’s settings before saving. It will save our custom field column data.

   if ( ! function_exists( 'wpdocs_update_custom_field_in_widget_form' ) ) {
   
       add_action( 'widget_update_callback', 'wpdocs_update_custom_field_in_widget_form', 10, 2 );
   
       /**
        * Update widget fields
        * Filters a widget’s settings before saving.
        */
       function wpdocs_update_custom_field_in_widget_form( $instance, $new_instance ) {
           $instance['column'] = ! empty( $new_instance['column'] ) ? $new_instance['column'] : '';
           return $instance;
       }
   }