Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
03/18/2018 09:56:44 PM (8 years ago)
Author:
djpaul
Message:

Templates, Nouveau: fix @since PHPDoc.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/bp-templates/bp-nouveau/includes/template-tags.php

    r11856 r11899  
    33 * Common template tags
    44 *
    5  * @since 1.0.0
     5 * @since 3.0.0
    66 */
    77
    … …  
    1212 * Fire specific hooks at various places of templates
    1313 *
    14  * @since 1.0.0
     14 * @since 3.0.0
    1515 *
    1616 * @param array $pieces The list of terms of the hook to join.
    … …  
    3434 * Fire plugin hooks in the plugins.php template (Groups and Members single items)
    3535 *
    36  * @since 1.0.0
     36 * @since 3.0.0
    3737 *
    3838 * @param string The suffix of the hook.
    … …  
    5858 *       once we'll need other friends template tags.
    5959 *
    60  * @since 1.0.0
     60 * @since 3.0.0
    6161 *
    6262 * @param string The suffix of the hook.
    … …  
    7979 * Add classes to style the template notice/feedback message
    8080 *
    81  * @since 1.0.0
     81 * @since 3.0.0
    8282 */
    8383function bp_nouveau_template_message_classes() {
    … …  
    9595     * Get the template notice/feedback message type
    9696     *
    97      * @since 1.0.0
     97     * @since 3.0.0
    9898     *
    9999     * @return string The type of the notice. Defaults to error.
    … …  
    115115 * Checks if a template notice/feedback message is set
    116116 *
    117  * @since 1.0.0
     117 * @since 3.0.0
    118118 *
    119119 * @return bool True if a template notice is set. False otherwise.
    … …  
    137137    *
    138138 *
    139  * @since 1.0.0
     139 * @since 3.0.0
    140140 *
    141141 * @return bool True if a template notice needs a dismiss button. False otherwise.
    … …  
    163163 * Currently template_notices(BP) will take $type = 'clear' if button set to true.
    164164 *
    165  * @since 1.0.0
     165 * @since 3.0.0
    166166 */
    167167function bp_nouveau_dismiss_button_type() {
    … …  
    179179 * Displays a template notice/feedback message.
    180180 *
    181  * @since 1.0.0
     181 * @since 3.0.0
    182182 */
    183183function bp_nouveau_template_message() {
    … …  
    188188     * Get the template notice/feedback message and make sure core filter is applied.
    189189     *
    190      * @since 1.0.0
     190     * @since 3.0.0
    191191     *
    192192     * @return string HTML Output.
    … …  
    222222 * Template tag to display feedback notices to users, if there are to display
    223223 *
    224  * @since 1.0.0
     224 * @since 3.0.0
    225225 */
    226226function bp_nouveau_template_notices() {
    … …  
    254254         * Fires after the display of any template_notices feedback messages.
    255255         *
    256          * @since 1.1.0
     256         * @since 3.0.0
    257257         */
    258258        do_action( 'bp_core_render_message' );
    … …  
    262262     * Fires towards the top of template pages for notice display.
    263263     *
    264      * @since 1.0.0
     264     * @since 3.0.0
    265265     */
    266266    do_action( 'template_notices' );
    … …  
    270270 * Displays a feedback message to the user.
    271271 *
    272  * @since 1.0.0
     272 * @since 3.0.0
    273273 *
    274274 * @param string $feedback_id The ID of the message to display
    … …  
    296296         * Filter here if you wish to use a different templates than the notice one.
    297297         *
    298          * @since 1.0.0
     298         * @since 3.0.0
    299299         *
    300300         * @param string path to your template part.
    … …  
    314314 * Template tag to wrap the before component loop
    315315 *
    316  * @since 1.0.0
     316 * @since 3.0.0
    317317 */
    318318function bp_nouveau_before_loop() {
    … …  
    334334 * Template tag to wrap the after component loop
    335335 *
    336  * @since 1.0.0
     336 * @since 3.0.0
    337337 */
    338338function bp_nouveau_after_loop() {
    … …  
    356356 * @param string $position
    357357 *
    358  * @since 1.0.0
     358 * @since 3.0.0
    359359 */
    360360function bp_nouveau_pagination( $position ) {
    … …  
    439439         * Fires after the component directory list.
    440440         *
    441          * @since 1.1.0
     441         * @since 3.0.0
    442442         */
    443443        do_action( $bottom_hook );
    … …  
    474474         * Fires before the component directory list.
    475475         *
    476          * @since 1.1.0
     476         * @since 3.0.0
    477477         */
    478478        do_action( $top_hook );
    … …  
    483483 * Display the component's loop classes
    484484 *
    485  * @since 1.0.0
     485 * @since 3.0.0
    486486 *
    487487 * @return string CSS class attributes (escaped).
    … …  
    494494     * Get the component's loop classes
    495495     *
    496      * @since 1.0.0
     496     * @since 3.0.0
    497497     *
    498498     * @return string space separated value of classes.
    … …  
    562562         * NB: you can also directly add classes into the template parts.
    563563         *
    564          * @since 1.0.0
     564         * @since 3.0.0
    565565         *
    566566         * @param array  $classes   The list of classes.
    … …  
    576576 * Checks if the layout preferences is set to grid (2 or more columns).
    577577 *
    578  * @since 1.0.0
     578 * @since 3.0.0
    579579 *
    580580 * @return bool True if loop is displayed in grid mod. False otherwise.
    … …  
    590590 * Returns the number of columns of the layout preferences.
    591591 *
    592  * @since 1.0.0
     592 * @since 3.0.0
    593593 *
    594594 * @return int The number of columns.
    … …  
    607607     * Filter number of columns for this grid.
    608608     *
    609      * @since 1.0.0
     609     * @since 3.0.0
    610610     *
    611611     * @param int $columns The number of columns.
    … …  
    618618 * Checks if activity, members, groups, blogs has the vert nav layout selected
    619619 *
    620  * @since 1.0.0
     620 * @since 3.0.0
    621621 *
    622622 * @return bool.
    … …  
    632632 * Get the full size avatar args.
    633633 *
    634  * @since 1.0.0
     634 * @since 3.0.0
    635635 *
    636636 * @return array The avatar arguments.
    … …  
    662662 * Init the Navigation Loop and check it has items.
    663663 *
    664  * @since 1.0.0
     664 * @since 3.0.0
    665665 *
    666666 * @param array $args {
    … …  
    756756         * Use the $n param to check for your custom object.
    757757         *
    758          * @since 1.0.0
     758         * @since 3.0.0
    759759         *
    760760         * @param array $nav The list of item navigations generated by the BP_Core_Nav API.
    … …  
    785785 * Checks there are still nav items to display.
    786786 *
    787  * @since 1.0.0
     787 * @since 3.0.0
    788788 *
    789789 * @return bool True if there are still items to display. False otherwise.
    … …  
    805805 * Sets the current nav item and prepare the navigation loop to iterate to next one.
    806806 *
    807  * @since 1.0.0
     807 * @since 3.0.0
    808808 */
    809809function bp_nouveau_nav_item() {
    … …  
    817817 * Displays the nav item ID.
    818818 *
    819  * @since 1.0.0
     819 * @since 3.0.0
    820820 */
    821821function bp_nouveau_nav_id() {
    … …  
    826826     * Retrieve the ID attribute of the current nav item.
    827827     *
    828      * @since 1.0.0
     828     * @since 3.0.0
    829829     *
    830830     * @return string the ID attribute.
    … …  
    845845         * Filter to edit the ID attribute of the nav.
    846846         *
    847          * @since 1.0.0
     847         * @since 3.0.0
    848848         *
    849849         * @param string $id       The ID attribute of the nav.
    … …  
    857857 * Displays the nav item classes.
    858858 *
    859  * @since 1.0.0
     859 * @since 3.0.0
    860860 */
    861861function bp_nouveau_nav_classes() {
    … …  
    866866     * Retrieve a space separated list of classes for the current nav item.
    867867     *
    868      * @since 1.0.0
     868     * @since 3.0.0
    869869     *
    870870     * @return string List of classes.
    … …  
    909909         * NB: you can also directly add classes into the template parts.
    910910         *
    911          * @since 1.0.0
     911         * @since 3.0.0
    912912         *
    913913         * @param string $value    A space separated list of classes.
    … …  
    927927 * Displays the nav item scope.
    928928 *
    929  * @since 1.0.0
     929 * @since 3.0.0
    930930 */
    931931function bp_nouveau_nav_scope() {
    … …  
    936936     * Retrieve the specific scope for the current nav item.
    937937     *
    938      * @since 1.0.0
     938     * @since 3.0.0
    939939     *
    940940     * @return string the specific scope of the nav.
    … …  
    955955             * Filter to add your own scope.
    956956             *
    957              * @since 1.0.0
     957             * @since 3.0.0
    958958             *
    959959             * @param array $scope     Contains the key and the value for your scope.
    … …  
    974974 * Displays the nav item URL.
    975975 *
    976  * @since 1.0.0
     976 * @since 3.0.0
    977977 */
    978978function bp_nouveau_nav_link() {
    … …  
    983983     * Retrieve the URL for the current nav item.
    984984     *
    985      * @since 1.0.0
     985     * @since 3.0.0
    986986     *
    987987     * @return string The URL for the nav item.
    … …  
    10071007         * Filter to edit the URL of the nav item.
    10081008         *
    1009          * @since 1.0.0
     1009         * @since 3.0.0
    10101010         *
    10111011         * @param string $link     The URL for the nav item.
    … …  
    10191019 * Displays the nav item link ID.
    10201020 *
    1021  * @since 1.0.0
     1021 * @since 3.0.0
    10221022 */
    10231023function bp_nouveau_nav_link_id() {
    … …  
    10281028     * Retrieve the id attribute of the link for the current nav item.
    10291029     *
    1030      * @since 1.0.0
     1030     * @since 3.0.0
    10311031     *
    10321032     * @return string The link id for the nav item.
    … …  
    10501050         * Filter to edit the link id attribute of the nav.
    10511051         *
    1052          * @since 1.0.0
     1052         * @since 3.0.0
    10531053         *
    10541054         * @param string $link_id  The link id attribute for the nav item.
    … …  
    10621062 * Displays the nav item link title.
    10631063 *
    1064  * @since 1.0.0
     1064 * @since 3.0.0
    10651065 */
    10661066function bp_nouveau_nav_link_title() {
    … …  
    10711071     * Retrieve the title attribute of the link for the current nav item.
    10721072     *
    1073      * @since 1.0.0
     1073     * @since 3.0.0
    10741074     *
    10751075     * @return string The link title for the nav item.
    … …  
    10941094         * Filter to edit the link title attribute of the nav.
    10951095         *
    1096          * @since 1.0.0
     1096         * @since 3.0.0
    10971097         *
    10981098         * @param string $title    The link title attribute for the nav item.
    … …  
    11061106 * Displays the nav item link html text.
    11071107 *
    1108  * @since 1.0.0
     1108 * @since 3.0.0
    11091109 */
    11101110function bp_nouveau_nav_link_text() {
    … …  
    11151115     * Retrieve the html text of the link for the current nav item.
    11161116     *
    1117      * @since 1.0.0
     1117     * @since 3.0.0
    11181118     *
    11191119     * @return string The html text for the nav item.
    … …  
    11381138         * Filter to edit the html text of the nav.
    11391139         *
    1140          * @since 1.0.0
     1140         * @since 3.0.0
    11411141         *
    11421142         * @param string $link_text The html text of the nav item.
    … …  
    11501150 * Checks if the nav item has a count attribute.
    11511151 *
    1152  * @since 1.0.0
     1152 * @since 3.0.0
    11531153 *
    11541154 * @return bool
    … …  
    11701170     * Filter to edit whether the nav has a count attribute.
    11711171     *
    1172      * @since 1.0.0
     1172     * @since 3.0.0
    11731173     *
    11741174     * @param bool   $value     True if the nav has a count attribute. False otherwise
    … …  
    11821182 * Displays the nav item count attribute.
    11831183 *
    1184  * @since 1.0.0
     1184 * @since 3.0.0
    11851185 */
    11861186function bp_nouveau_nav_count() {
    … …  
    11911191     * Retrieve the count attribute for the current nav item.
    11921192     *
    1193      * @since 1.0.0
     1193     * @since 3.0.0
    11941194     *
    11951195     * @return int The count attribute for the nav item.
    … …  
    12211221         * Filter to edit the count attribute for the nav item.
    12221222         *
    1223          * @since 1.0.0
     1223         * @since 3.0.0
    12241224         *
    12251225         * @param int $count    The count attribute for the nav item.
    … …  
    12351235 * Displays the directory nav class.
    12361236 *
    1237  * @since 1.0.0
     1237 * @since 3.0.0
    12381238 */
    12391239function bp_nouveau_directory_type_navs_class() {
    … …  
    12471247     * Gets user selection Customizer options.
    12481248     *
    1249      * @since 1.0.0
     1249     * @since 3.0.0
    12501250     *
    12511251     * @return string
    … …  
    12801280         * NB: you can also directly add classes to the class attr.
    12811281         *
    1282          * @since 1.0.0
     1282         * @since 3.0.0
    12831283         *
    12841284         * @param array $nav_wrapper_classes The list of classes.
    … …  
    12921292 * Displays the directory nav item list class.
    12931293 *
    1294  * @since 1.0.0
     1294 * @since 3.0.0
    12951295 */
    12961296function bp_nouveau_directory_list_class() {
    … …  
    13011301     * Gets the directory nav item list class.
    13021302     *
    1303      * @since 1.0.0
     1303     * @since 3.0.0
    13041304     */
    13051305    function bp_nouveau_get_directory_list_class() {
    … …  
    13101310 * Displays the directory nav item object (data-bp attribute).
    13111311 *
    1312  * @since 1.0.0
     1312 * @since 3.0.0
    13131313 */
    13141314function bp_nouveau_directory_nav_object() {
    … …  
    13251325     * @see BP_Component::setup_nav().
    13261326     *
    1327      * @since 1.0.0
     1327     * @since 3.0.0
    13281328     *
    13291329     * @return array
    … …  
    13451345 * Output main BuddyPress container classes.
    13461346 *
    1347  * @since 1.0.0
     1347 * @since 3.0.0
    13481348 *
    13491349 * @return string CSS classes
    … …  
    13561356     * Returns the main BuddyPress container classes.
    13571357     *
    1358      * @since 1.0.0
     1358     * @since 3.0.0
    13591359     *
    13601360     * @return string CSS classes
    … …  
    14451445 * Output single item nav container classes
    14461446 *
    1447  * @since 1.0.0
     1447 * @since 3.0.0
    14481448 *
    14491449 * @return string CSS classes
    … …  
    14561456     * Returns the single item nav container classes
    14571457     *
    1458      * @since 1.0.0
     1458     * @since 3.0.0
    14591459     *
    14601460     * @return string CSS classes
    … …  
    15101510 * Output single item subnav container classes.
    15111511 *
    1512  * @since 1.0.0
     1512 * @since 3.0.0
    15131513 *
    15141514 * @return string CSS classes
    … …  
    15211521     * Returns the single item subnav container classes.
    15221522     *
    1523      * @since 1.0.0
     1523     * @since 3.0.0
    15241524     *
    15251525     * @return string CSS classes
    … …  
    15601560 * Output the groups create steps classes.
    15611561 *
    1562  * @since 1.0.0
     1562 * @since 3.0.0
    15631563 *
    15641564 * @return string CSS classes
    … …  
    15711571     * Returns the groups create steps customizer option choice class.
    15721572     *
    1573      * @since 1.0.0
     1573     * @since 3.0.0
    15741574     *
    15751575     * @return string CSS classes
    … …  
    15941594 * Get the search primary object
    15951595 *
    1596  * @since 1.0.0
     1596 * @since 3.0.0
    15971597 *
    15981598 * @param string $object Optional. The primary object.
    … …  
    16171617 * Get The list of search objects (primary + secondary).
    16181618 *
    1619  * @since 1.0.0
     1619 * @since 3.0.0
    16201620 *
    16211621 * @param array $objects Optional. The list of objects.
    … …  
    16471647 * Output the search form container classes.
    16481648 *
    1649  * @since 1.0.0
     1649 * @since 3.0.0
    16501650 */
    16511651function bp_nouveau_search_container_class() {
    … …  
    16591659 * Output a selector ID.
    16601660 *
    1661  * @since 1.0.0
     1661 * @since 3.0.0
    16621662 *
    16631663 * @param string $suffix Optional. A string to append at the end of the ID.
    … …  
    16741674 * Output the name attribute of a selector.
    16751675 *
    1676  * @since 1.0.0
     1676 * @since 3.0.0
    16771677 *
    16781678 * @param  string $suffix Optional. A string to append at the end of the name.
    … …  
    16961696 * Output the default search text for the search object
    16971697 *
    1698  * @since 1.0.0
     1698 * @since 3.0.0
    16991699 *
    17001700 * @param  string $text    Optional. The default search text for the search object.
    … …  
    17231723 * Get the search form template part and fire some do_actions if needed.
    17241724 *
    1725  * @since 1.0.0
     1725 * @since 3.0.0
    17261726 */
    17271727function bp_nouveau_search_form() {
    … …  
    17851785 * IDs/labels for group/activity & similar screens.
    17861786 *
    1787  * @since 1.0.0
     1787 * @since 3.0.0
    17881788 */
    17891789function bp_nouveau_current_object() {
    … …  
    18141814 * Output data filter container's ID attribute value.
    18151815 *
    1816  * @since 1.0.0
     1816 * @since 3.0.0
    18171817 */
    18181818function bp_nouveau_filter_container_id() {
    … …  
    18231823     * Get data filter container's ID attribute value.
    18241824     *
    1825      * @since 1.0.0
     1825     * @since 3.0.0
    18261826     *
    18271827     * @param string
    … …  
    18491849 * Output data filter's ID attribute value.
    18501850 *
    1851  * @since 1.0.0
     1851 * @since 3.0.0
    18521852 */
    18531853function bp_nouveau_filter_id() {
    … …  
    18581858     * Get data filter's ID attribute value.
    18591859     *
    1860      * @since 1.0.0
     1860     * @since 3.0.0
    18611861     *
    18621862     * @param string
    … …  
    18841884 * Output data filter's label.
    18851885 *
    1886  * @since 1.0.0
     1886 * @since 3.0.0
    18871887 */
    18881888function bp_nouveau_filter_label() {
    … …  
    18931893     * Get data filter's label.
    18941894     *
    1895      * @since 1.0.0
     1895     * @since 3.0.0
    18961896     *
    18971897     * @param string
    … …  
    19111911 * Output data filter's data-bp-filter attribute value.
    19121912 *
    1913  * @since 1.0.0
     1913 * @since 3.0.0
    19141914 */
    19151915function bp_nouveau_filter_component() {
    … …  
    19211921 * Output the <option> of the data filter's <select> element.
    19221922 *
    1923  * @since 1.0.0
     1923 * @since 3.0.0
    19241924 */
    19251925function bp_nouveau_filter_options() {
    … …  
    19301930     * Get the <option> of the data filter's <select> element.
    19311931     *
    1932      * @since 1.0.0
     1932     * @since 3.0.0
    19331933     *
    19341934     * @return string
    … …  
    19611961 * Get a link to reach a specific section into the customizer
    19621962 *
    1963  * @since 1.0.0
     1963 * @since 3.0.0
    19641964 *
    19651965 * @param array $args Optional. The argument to customize the Customizer link.
    … …  
    20222022 * Fire specific hooks into the register template
    20232023 *
    2024  * @since 1.0.0
     2024 * @since 3.0.0
    20252025 *
    20262026 * @param string $when   'before' or 'after'
    … …  
    20542054 * Fire specific hooks into the activate template
    20552055 *
    2056  * @since 1.0.0
     2056 * @since 3.0.0
    20572057 *
    20582058 * @param string $when   'before' or 'after'
    … …  
    20822082 * Output the signup form for the requested section
    20832083 *
    2084  * @since 1.0.0
     2084 * @since 3.0.0
    20852085 *
    20862086 * @param string $section Optional. The section of fields to get 'account_details' or 'blog_details'.
    … …  
    22442244 * Output a submit button and the nonce for the requested action.
    22452245 *
    2246  * @since 1.0.0
     2246 * @since 3.0.0
    22472247 *
    22482248 * @param string $action The action to get the submit button for. Required.
    … …  
    22822282 * @param string $type optional: the type of error message e.g 'error'.
    22832283 *
    2284  * @since 1.0.0
     2284 * @since 3.0.0
    22852285 */
    22862286function nouveau_error_template( $message = '', $type = '' ) {
Note: See TracChangeset for help on using the changeset viewer.