[buddypress-trac] [BuddyPress Trac] #9319: Clarify phpdoc return types for template helper functions
buddypress-trac
noreply at wordpress.org
Wed Dec 31 04:30:20 UTC 2025
#9319: Clarify phpdoc return types for template helper functions
------------------------------+------------------------------
Reporter: manhphucofficial | Owner: (none)
Type: enhancement | Status: new
Priority: normal | Milestone: Awaiting Review
Component: Core | Version:
Severity: normal | Resolution:
Keywords: has-patch |
------------------------------+------------------------------
Changes (by prbot):
* keywords: => has-patch
Comment:
''This ticket was mentioned in
[https://github.com/buddypress/buddypress/pull/433 PR #433] on
[https://github.com/buddypress/buddypress/ buddypress/buddypress] by
[https://profiles.wordpress.org/manhphucofficial/ @manhphucofficial].''
This PR updates a couple of PHPDoc `@return` annotations that currently
use
`mixed`, even though the functions return well-defined values.
The changes clarify the return types based on the existing behavior:
- `bp_format_time()` returns a formatted string on success or `false` on
failure.
- `bp_get_activity_parent_content()` returns a string or `false` when no
parent
content is available.
This is a documentation-only change and does not affect runtime behavior.
This PR addresses Trac ticket #9319:
https://buddypress.trac.wordpress.org/ticket/9319
--
Ticket URL: <https://buddypress.trac.wordpress.org/ticket/9319#comment:2>
BuddyPress Trac <http://buddypress.org/>
BuddyPress Trac
More information about the buddypress-trac
mailing list