Context Navigation

← Previous Ticket
Next Ticket →

#31048 closed defect (bug) (fixed)

Missing PHPDoc $content param text in shortcode.php

Reported by:	cais	Owned by:	DrewAPicture
Priority:	normal	Milestone:	4.2
Component:	Shortcodes	Version:	3.6
Severity:	normal	Keywords:
Cc:		Focuses:	docs

Description

There appears to be no PHPDoc param text for the $content variable being passed to has_shortcode(). The attached patch uses the same text for $content as used in do_shortcode().

Attachments (2)

31048.patch (473 bytes ) - added by cais 11 years ago.
31048.2.patch (1.2 KB ) - added by SergeyBiryukov 11 years ago.

Download all attachments as: .zip

Change History (8)

@cais
11 years ago

Attachment 31048.patch added

#1 follow-up: ↓ 3 @DrewAPicture
11 years ago

Milestone Awaiting Review → 4.2

Hi cais, thanks for the patch.

I think if we're in there adding a missing parameter and description, we should probably also cover the description for $tag and the return value. Would you care to include those in your patch?

@SergeyBiryukov
11 years ago

Attachment 31048.2.patch added

#2 @SergeyBiryukov
11 years ago

Noticed some other inconsistencies, see 31048.2.patch .

Last edited 11 years ago by SergeyBiryukov (previous) (diff)

#3 in reply to: ↑ 1 @cais
11 years ago

Replying to DrewAPicture:

Hi cais, thanks for the patch.

I think if we're in there adding a missing parameter and description, we should probably also cover the description for $tag and the return value. Would you care to include those in your patch?

... looks like I wasn't quick enough. Sergey appears to have covered those.

#4 @DrewAPicture
11 years ago

In 31242:

Ensure both parameters and the return for has_shortcode() are fully documented.

Props cais, SergeyBiryukov
See #31048.

#5 @DrewAPicture
11 years ago

Owner set to DrewAPicture
Resolution → fixed
Status new → closed

In 31243:

Add more complete documentation for parameters, globals, and return values to the DocBlocks for remove_shortcode(), shortcode_exists(), and do_shortcode().

Props SergeyBiryukov.
Fixes #31048.

#6 @DrewAPicture
11 years ago

In 31245:

Remove a stray period introduced in [31242].

Props SergeyBiryukov.
See #31048.

Note: See TracTickets for help on using tickets.

Download in other formats:

Make WordPress Core

Context Navigation

#31048 closed defect (bug) (fixed)

Missing PHPDoc $content param text in shortcode.php

Description

Attachments (2)

Change History (8)

@cais 11 years ago

#1 follow-up: ↓ 3 @DrewAPicture 11 years ago

@SergeyBiryukov 11 years ago

#2 @SergeyBiryukov 11 years ago

#3 in reply to: ↑ 1 @cais 11 years ago

#4 @DrewAPicture 11 years ago

#5 @DrewAPicture 11 years ago

#6 @DrewAPicture 11 years ago