Context Navigation

← Previous Ticket
Next Ticket →

#25508 closed defect (bug) (fixed)

Hooks Docs: wp-includes/admin-bar.php

Reported by:	swissspidy	Owned by:	kpdesign
Priority:	normal	Milestone:	3.8
Component:	Inline Docs	Version:
Severity:	normal	Keywords:	has-patch commit
Cc:		Focuses:

Description

Patch forthcoming

Attachments (3)

25508.diff (2.3 KB ) - added by swissspidy 13 years ago.
25508.2.diff (2.4 KB ) - added by swissspidy 13 years ago.
25508.3.diff (2.4 KB ) - added by DrewAPicture 13 years ago.: Clean up

Download all attachments as: .zip

Change History (13)

@swissspidy
13 years ago

Attachment 25508.diff added

#1 @swissspidy
13 years ago

Keywords has-patch added; needs-patch removed

First pass at inline docs for this file's hooks.

#2 @swissspidy
13 years ago

#25512 was marked as a duplicate.

#3 @kpdesign
13 years ago

Keywords needs-patch added; has-patch removed

@swissspidy: Thanks for the patch. :)

Just a few things that need fixed:

General:

All short/long descriptions and @param descriptions need periods at the end.

wp_admin_bar_class:

Change @param to @param WP_Admin_Bar The WP_Admin_Bar instance, passed by reference.

wp_before_admin_bar_render:

Remove the blank line after @since, as there's no parameters to be listed.

show_admin_bar:

s/wheter/whether in short description and @param description.
Change long description to say that show_admin_bar is the recommended way to hide the toolbar.
Existing long description should be moved to the @param description, like:

* @param bool $show_admin_bar Whether the admin bar should be shown. Default 'false'.
*                             The user's display preference is used for logged in users.

Could you make these changes and upload a new patch please? :)

Also, please do not overwrite your existing patch. If you use the same filename, Trac will append a number to the filename to indicate it's a new version. We like to keep all patch versions for the ticket history.