WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_Widget::form()

WP_Widget::form( array $instance ): string|void

In this article

Back to top

Outputs the settings update form.

Parameters

$instancearrayrequired
The settings for the particular instance of the widget.

Return

string|void Default return is 'noform'.

Source

public function form( $instance ) {
	echo '<p class="no-options-widget">' . __( 'There are no options for this widget.' ) . '</p>';
	return 'noform';
}

View all references View on Trac View on GitHub

Used byDescription
WP_Widget::form_callback()wp-includes/class-wp-widget.php

Generates the widget control form (Do NOT override).

Changelog

VersionDescription
2.8.0Introduced.

User Contributed Notes

  1. Skip to note 2 content
    Ian Dunn
    You must log in to vote on the helpfulness of this noteVote results for this note: 3You must log in to vote on the helpfulness of this note

    Ever wonder why your IDE complains that your form() method isn’t returning a value?

    WP_Widget::form returns 'noform' by default, so technically any class that extends WP_Widget should also return a string. The vast majority of widgets don’t have any return statement, so they implicitly return NULL.

    wp-admin/widgets.php checks the return value when rendering the widget’s form, and if the value is 'noform', then it hides the Save button. If the value is anything else, it shows the Save button.

    So, you should technically return a string inside your form() method, even if it’s just an empty string, but the Save button will still show up even if you don’t.

You must log in before being able to contribute a note or feedback.