WordPress.org

Make WordPress Core

Opened 4 years ago

Closed 4 years ago

#34013 closed task (blessed) (fixed)

Tracking Ticket: Improve method documentation in core widget classes

Reported by: DrewAPicture Owned by: DrewAPicture
Milestone: 4.4 Priority: normal
Severity: normal Version:
Component: Widgets Keywords: good-first-bug
Focuses: docs Cc:
PR Number:

Description (last modified by DrewAPicture)

The core widget classes have gone long enough not having complete method documentation. What makes this especially late-in-coming is the fact that the form(), widget(), and update() methods in WP_Widget base class already have docs, most of the time we just need to copy them to the sub-classes and make some minor adjustments to tailor to the specific widget type.

And now that all of the core widget classes are in their own fancy new files as of [33843], there's no better time than now to spruce them up. In #33701 I already fixed the file headers and class DocBlocks, now we just need the method docs.

Let's do it.

Tickets by file:

  • #34015WP_Nav_Menu_Widget => class-wp-nav-menu-widget.php
  • #34016WP_Widget_Archives => class-wp-widget-archives.php
  • #34017WP_Widget_Calendar => class-wp-widget-calendar.php
  • #34018WP_Widget_Categories => class-wp-widget-categories.php
  • #34019WP_Widget_Links => class-wp-widget-links.php
  • #34020WP_Widget_Meta => class-wp-widget-meta.php
  • #34021WP_Widget_Pages => class-wp-widget-pages.php
  • #34022WP_Widget_Recent_Comments => class-wp-widget-recent-comments.php
  • #34023WP_Widget_Recent_Posts => class-wp-widget-recent-posts.php
  • #34024WP_Widget_RSS => class-wp-widget-rss.php
  • #34025WP_Widget_Search => class-wp-widget-search.php
  • #34026WP_Widget_Tag_Cloud => class-wp-widget-tag-cloud.php
  • #34027WP_Widget_Text => class-wp-widget-text.php

Change History (15)

#1 @DrewAPicture
4 years ago

  • Description modified (diff)
  • Keywords good-first-bug added

#2 @DrewAPicture
4 years ago

  • Owner set to DrewAPicture
  • Status changed from new to reviewing

#3 @DrewAPicture
4 years ago

In 34560:

Docs: Improve the method docs for the widget(), update(), form(), and __construct() methods in the WP_Widget base class.

See #34013. See #32246.

#4 @DrewAPicture
4 years ago

In 34610:

Docs: Improve the documentation for the __construct(), widget(), update(), and form() methods in WP_Widget_Tag_Cloud.

Props leemon.
Fixes #34026. See #34013.

#5 @DrewAPicture
4 years ago

In 34611:

Docs: Improve documentation for the __construct(), widget(), update(), and form() methods in WP_Widget_Search.

Props leemon.
Fixes #34025. See #34013.

#6 @DrewAPicture
4 years ago

In 34612:

Docs: Improve documentation for the __construct(), widget(), update(), and form() methods in WP_Widget_RSS.

Props leemon.
Fixes #34024. See #34013.

#7 @DrewAPicture
4 years ago

In 34613:

Docs: Improve documentation for the __construct(), widget(), update(), and form() methods in WP_Widget_Recent_Posts.

Also fixes a typo in the class DocBlock.

Props leemon.
Fixes #34023. See #34013.

#8 @DrewAPicture
4 years ago

In 34614:

Docs: Improve documentation for the __construct(), recent_comments_style(), widget(), update(), and form() methods in WP_Widget_Recent_Comments.

Also fixes a typo in the class DocBlock.

Props leemon.
Fixes #34022. See #34013.

#9 @DrewAPicture
4 years ago

In 34615:

Docs: Improve documentation for the __construct(), widget(), update(), and form() methods in WP_Widget_Pages.

Props leemon.
Fixes #34021. See #34013.

#10 @DrewAPicture
4 years ago

In 34616:

Docs: Improve documentation for the __construct(), widget(), update(), and form() methods in WP_Widget_Meta.

Props leemon.
Fixes #34020. See #34013.

#11 @DrewAPicture
4 years ago

In 34617:

Docs: Improve documentation for the __construct(), widget(), update(), and form() methods in WP_Widget_Links.

Props leemon.
Fixes #34019. See #34013.

#12 @DrewAPicture
4 years ago

In 34618:

Docs: Improve documentation for the __construct(), widget(), update(), form(), and _get_current_taxonomy() methods in WP_Widget_Categories.

Props leemon.
Fixes #34018. See #34013.

#13 @DrewAPicture
4 years ago

In 34619:

Docs: Improve documentation for the __construct(), widget(), update(), and form() methods in WP_Widget_Calendar.

Props leemon.
Fixes #34017. See #34013.

#14 @DrewAPicture
4 years ago

In 34620:

Docs: Improve documentation for the __construct(), widget(), update(), and form() methods in WP_Widget_Archives.

Props leemon.
Fixes #34016. See #34013.

#15 @DrewAPicture
4 years ago

  • Resolution set to fixed
  • Status changed from reviewing to closed

In 34621:

Docs: Improve documentation for the __construct(), widget(), update(), and form() methods in WP_Nav_Menu_Widget.

Props leemon.
Fixes #34015. Fixes #34013.

Note: See TracTickets for help on using tickets.