WP_Widget::form( array $instance ): string

Outputs the settings update form.

Contents

Parameters

$instance array Required
Current settings.

Top ↑

Return

string Default return is 'noform'.

Top ↑

Source

File: wp-includes/class-wp-widget.php. View all references 

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

View on Trac View on GitHub

Top ↑

Top ↑

Uses

Uses
Uses Description
__() wp-includes/l10n.php

Retrieves the translation of $text.

Top ↑

Changelog

Changelog
Version Description
2.8.0 Introduced.

Top ↑

User Contributed Notes

  1. Skip to note 1 content
    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
    Contributed by Ian Dunn —

    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.