Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
01/07/2023 12:18:55 AM (2 years ago)
Author:
espellcaste
Message:

PHPDoc: adding improvements to the @global tag definition.

The @global tag is used to inform PHPDoc of a global variable or its usage. The tag was updated where necessary and invalid examples were removed.

Closes ​https://github.com/buddypress/buddypress/pull/53
Fixes #8786

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/bp-messages/bp-messages-template.php

    r13300 r13395  
    2020 * @since 1.0.0
    2121 *
    22  * @global BP_Messages_Box_Template $messages_template
     22 * @global BP_Messages_Box_Template $messages_template The message box template loop class.
    2323 *
    2424 * @param array|string $args {
    … …  
    106106 * Check whether there are more threads to iterate over.
    107107 *
    108  * @global BP_Messages_Box_Template $messages_template
     108 * @global BP_Messages_Box_Template $messages_template The message box template loop class.
    109109 *
    110110 * @return bool
    … …  
    118118 * Set up the current thread inside the loop.
    119119 *
    120  * @global BP_Messages_Box_Template $messages_template
     120 * @global BP_Messages_Box_Template $messages_template The message box template loop class.
    121121 *
    122122 * @return BP_Messages_Thread
    … …  
    136136     * Get the ID of the current thread in the loop.
    137137     *
    138      * @global BP_Messages_Box_Template $messages_template
     138     * @global BP_Messages_Box_Template $messages_template The message box template loop class.
    139139     *
    140140     * @return int
    … …  
    162162     * Get the subject of the current thread in the loop.
    163163     *
    164      * @global BP_Messages_Box_Template $messages_template
     164     * @global BP_Messages_Box_Template $messages_template The message box template loop class.
    165165     *
    166166     * @return string
    … …  
    188188     * Generate an excerpt from the current message in the loop.
    189189     *
    190      * @global BP_Messages_Box_Template $messages_template
     190     * @global BP_Messages_Box_Template $messages_template The message box template loop class.
    191191     *
    192192     * @return string
    … …  
    230230     * @since 2.0.0
    231231     *
    232      * @global BP_Messages_Box_Template $messages_template
     232     * @global BP_Messages_Box_Template $messages_template The message box template loop class.
    233233     *
    234234     * @return string The raw content of the last message in the thread.
    … …  
    256256     * Get a link to the page of the current thread's last author.
    257257     *
    258      * @global BP_Messages_Box_Template $messages_template
     258     * @global BP_Messages_Box_Template $messages_template The message box template loop class.
    259259     *
    260260     * @return string
    … …  
    282282     * Generate HTML links to the pages of the current thread's recipients.
    283283     *
    284      * @global BP_Messages_Box_Template $messages_template
     284     * @global BP_Messages_Box_Template $messages_template The message box template loop class.
    285285     *
    286286     * @return string
    … …  
    317317     * @since 2.9.0 Introduced `$user_id` parameter.
    318318     *
    319      * @global BP_Messages_Box_Template $messages_template
     319     * @global BP_Messages_Box_Template $messages_template The message box template loop class.
    320320     *
    321321     * @param int $thread_id Optional. ID of the thread. Default: current
    … …  
    370370     * @since 2.9.0 Introduced `$user_id` parameter.
    371371     *
    372      * @global BP_Messages_Box_Template $messages_template
     372     * @global BP_Messages_Box_Template $messages_template The message box template loop class.
    373373     *
    374374     * @param int|null $user_id Optional. ID of the user relative to whom the link
    … …  
    528528     * Generate the CSS class for the current thread.
    529529     *
    530      * @global BP_Messages_Box_Template $messages_template
     530     * @global BP_Messages_Box_Template $messages_template The message box template loop class.
    531531     *
    532532     * @return string
    … …  
    554554 * Check whether the current thread has unread items.
    555555 *
    556  * @global BP_Messages_Box_Template $messages_template
     556 * @global BP_Messages_Box_Template $messages_template The message box template loop class.
    557557 *
    558558 * @return bool True if there are unread items, otherwise false.
    … …  
    582582     * Get the current thread's unread count.
    583583     *
    584      * @global BP_Messages_Box_Template $messages_template
     584     * @global BP_Messages_Box_Template $messages_template The message box template loop class.
    585585     *
    586586     * @return int
    … …  
    690690     * Get the unformatted date of the last post in the current thread.
    691691     *
    692      * @global BP_Messages_Box_Template $messages_template
     692     * @global BP_Messages_Box_Template $messages_template The message box template loop class.
    693693     *
    694694     * @return string
    … …  
    746746     *      return values.
    747747     *
    748      * @global BP_Messages_Box_Template $messages_template
     748     * @global BP_Messages_Box_Template $messages_template The message box template loop class.
    749749     *
    750750     * @param array|string $args {
    … …  
    842842     * Get the pagination HTML for the current thread loop.
    843843     *
    844      * @global BP_Messages_Box_Template $messages_template
     844     * @global BP_Messages_Box_Template $messages_template The message box template loop class.
    845845     *
    846846     * @return string
    … …  
    862862 * Generate the "Viewing message x to y (of z messages)" string for a loop.
    863863 *
    864  * @global BP_Messages_Box_Template $messages_template
     864 * @global BP_Messages_Box_Template $messages_template The message box template loop class.
    865865 */
    866866function bp_messages_pagination_count() {
    … …  
    11061106 * @since 1.6.0
    11071107 *
    1108  * @global BP_Messages_Box_Template $messages_template
     1108 * @global BP_Messages_Box_Template $messages_template The message box template loop class.
    11091109 *
    11101110 * @return bool
    … …  
    11661166     * Get the ID of the current notice in the loop.
    11671167     *
    1168      * @global BP_Messages_Box_Template $messages_template
     1168     * @global BP_Messages_Box_Template $messages_template The message box template loop class.
    11691169     *
    11701170     * @return int
    … …  
    11921192     * Get the post date of the current notice in the loop.
    11931193     *
    1194      * @global BP_Messages_Box_Template $messages_template
     1194     * @global BP_Messages_Box_Template $messages_template The message box template loop class.
    11951195     *
    11961196     * @return string
    … …  
    12241224     * @since 5.0.0 The $notice parameter has been added.
    12251225     *
    1226      * @global BP_Messages_Box_Template $messages_template
     1226     * @global BP_Messages_Box_Template $messages_template The message box template loop class.
    12271227     *
    12281228     * @param BP_Messages_Notice|null $notice The notice object.
    … …  
    12611261     * @since 5.0.0 The $notice parameter has been added.
    12621262     *
    1263      * @global BP_Messages_Box_Template $messages_template
     1263     * @global BP_Messages_Box_Template $messages_template The message box template loop class.
    12641264     *
    12651265     * @param BP_Messages_Notice|null $notice The notice object.
    … …  
    12921292     * Get the URL for deleting the current notice.
    12931293     *
    1294      * @global BP_Messages_Box_Template $messages_template
     1294     * @global BP_Messages_Box_Template $messages_template The message box template loop class.
    12951295     *
    12961296     * @return string Delete URL.
    … …  
    13191319     * Get the URL for deactivating the current notice.
    13201320     *
    1321      * @global BP_Messages_Box_Template $messages_template
     1321     * @global BP_Messages_Box_Template $messages_template The message box template loop class.
    13221322     *
    13231323     * @return string
    … …  
    13511351     * Generate the text ('Deactivate' or 'Activate') for the notice action link.
    13521352     *
    1353      * @global BP_Messages_Box_Template $messages_template
     1353     * @global BP_Messages_Box_Template $messages_template The message box template loop class.
    13541354     *
    13551355     * @return string
    … …  
    16691669 * Initialize the messages template loop for a specific thread.
    16701670 *
    1671  * @global BP_Messages_Thread_Template $thread_template
     1671 * @global BP_Messages_Thread_Template $thread_template Message Thread Template Class.
    16721672 *
    16731673 * @param array|string $args {
    … …  
    17221722     * Get the 'ASC' or 'DESC' messages order string for this loop.
    17231723     *
    1724      * @global BP_Messages_Thread_Template $thread_template
     1724     * @global BP_Messages_Thread_Template $thread_template Message Thread Template Class.
    17251725     *
    17261726     * @return string
    … …  
    17351735 * Check whether there are more messages to iterate over.
    17361736 *
    1737  * @global BP_Messages_Thread_Template $thread_template
     1737 * @global BP_Messages_Thread_Template $thread_template Message Thread Template Class.
    17381738 *
    17391739 * @return bool
    … …  
    17481748 * Set up the current thread inside the loop.
    17491749 *
    1750  * @global BP_Messages_Thread_Template $thread_template
     1750 * @global BP_Messages_Thread_Template $thread_template Message Thread Template Class.
    17511751 *
    17521752 * @return BP_Messages_Message
    … …  
    17671767     * Get the ID of the thread that the current loop belongs to.
    17681768     *
    1769      * @global BP_Messages_Thread_Template $thread_template
     1769     * @global BP_Messages_Thread_Template $thread_template Message Thread Template Class.
    17701770     *
    17711771     * @return int
    … …  
    17931793     * Get the subject of the thread currently being iterated over.
    17941794     *
    1795      * @global BP_Messages_Thread_Template $thread_template
     1795     * @global BP_Messages_Thread_Template $thread_template Message Thread Template Class.
    17961796     *
    17971797     * @return string
    … …  
    18421842 * @since 2.2.0
    18431843 *
    1844  * @global BP_Messages_Thread_Template $thread_template
     1844 * @global BP_Messages_Thread_Template $thread_template Message Thread Template Class.
    18451845 *
    18461846 * @return int
    … …  
    18901890     * @since 2.2.0
    18911891     *
    1892      * @global BP_Messages_Thread_Template $thread_template
     1892     * @global BP_Messages_Thread_Template $thread_template Message Thread Template Class.
    18931893     *
    18941894     * @return string
    … …  
    19391939     * @since 1.9.0
    19401940     *
    1941      * @global BP_Messages_Thread_Template $thread_template
     1941     * @global BP_Messages_Thread_Template $thread_template Message Thread Template Class.
    19421942     *
    19431943     * @return int
    … …  
    19731973     * @since 2.1.0
    19741974     *
    1975      * @global BP_Messages_Thread_Template $thread_template
     1975     * @global BP_Messages_Thread_Template $thread_template Message Thread Template Class.
    19761976     *
    19771977     * @return string
    … …  
    20142014     * Get the CSS class used for message zebra striping.
    20152015     *
    2016      * @global BP_Messages_Thread_Template $thread_template
     2016     * @global BP_Messages_Thread_Template $thread_template Message Thread Template Class.
    20172017     *
    20182018     * @return string
    … …  
    20492049     * @since 2.1.0
    20502050     *
    2051      * @global BP_Messages_Thread_Template $thread_template
     2051     * @global BP_Messages_Thread_Template $thread_template Message Thread Template Class.
    20522052     *
    20532053     * @return int
    … …  
    20822082     * Get the avatar for the current message sender.
    20832083     *
    2084      * @global BP_Messages_Thread_Template $thread_template
     2084     * @global BP_Messages_Thread_Template $thread_template Message Thread Template Class.
    20852085     *
    20862086     * @param array|string $args {
    … …  
    21362136     * @since 1.1.0
    21372137     *
    2138      * @global BP_Messages_Thread_Template $thread_template
     2138     * @global BP_Messages_Thread_Template $thread_template Message Thread Template Class.
    21392139     *
    21402140     * @return string
    … …  
    21662166     * @since 1.1.0
    21672167     *
    2168      * @global BP_Messages_Thread_Template $thread_template
     2168     * @global BP_Messages_Thread_Template $thread_template Message Thread Template Class.
    21692169     *
    21702170     * @return string
    … …  
    22922292     * @since 2.1.0
    22932293     *
    2294      * @global BP_Messages_Thread_Template $thread_template
     2294     * @global BP_Messages_Thread_Template $thread_template Message Thread Template Class.
    22952295     *
    22962296     * @return int
    … …  
    23222322     * @since 1.1.0
    23232323     *
    2324      * @global BP_Messages_Thread_Template $thread_template
     2324     * @global BP_Messages_Thread_Template $thread_template Message Thread Template Class.
    23252325     *
    23262326     * @return string
Note: See TracChangeset for help on using the changeset viewer.