Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
08/23/2021 12:12:09 AM (3 years ago)
Author:
espellcaste
Message:

Making PHPDoc Improvements to several files.

See #8553

File:
1 edited

Legend:

Unmodified
Added
Removed

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

    r12921 r13089  
    4242 * @since 3.0.0
    4343 *
    44  * @param string The suffix of the hook.
     44 * @param string $suffix The suffix of the hook.
    4545 */
    4646function bp_nouveau_plugin_hook( $suffix = '' ) {
    … …  
    6666 * @since 3.0.0
    6767 *
    68  * @param string The suffix of the hook.
     68 * @param string $suffix The suffix of the hook.
    6969 */
    7070function bp_nouveau_friend_hook( $suffix = '' ) {
    … …  
    9898    echo join( ' ', array_map( 'sanitize_html_class', $classes ) );
    9999}
    100 
    101100    /**
    102101     * Get the template notice/feedback message type
    … …  
    277276 * @since 3.0.0
    278277 *
    279  * @param string $feedback_id The ID of the message to display
     278 * @param string $feedback_id The ID of the message to display.
    280279 */
    281280function bp_nouveau_user_feedback( $feedback_id = '' ) {
    … …  
    380379 * Pagination for loops
    381380 *
    382  * @param string $position
    383  *
    384  * @since 3.0.0
     381 * @since 3.0.0
     382 *
     383 * @param string $position Pagination for loops.
    385384 */
    386385function bp_nouveau_pagination( $position ) {
    … …  
    530529 *
    531530 * @since 3.0.0
    532  *
    533  * @return string CSS class attributes (escaped).
    534531 */
    535532function bp_nouveau_loop_classes() {
    536533    echo esc_attr( bp_nouveau_get_loop_classes() );
    537534}
    538 
    539535    /**
    540536     * Get the component's loop classes
    … …  
    660656    $bp_nouveau = bp_nouveau();
    661657    $component  = sanitize_key( bp_current_component() );
    662 
    663     $columns = 1;
     658    $columns    = 1;
    664659
    665660    if ( ! empty( $bp_nouveau->{$component}->loop_layout ) ) {
    … …  
    915910    echo esc_attr( bp_nouveau_get_nav_id() );
    916911}
    917 
    918912    /**
    919913     * Retrieve the ID attribute of the current nav item.
    … …  
    955949    echo esc_attr( bp_nouveau_get_nav_classes() );
    956950}
    957 
    958951    /**
    959952     * Retrieve a space separated list of classes for the current nav item.
    … …  
    10311024    echo bp_nouveau_get_nav_scope();  // Escaped by bp_get_form_field_attributes().
    10321025}
    1033 
    10341026    /**
    10351027     * Retrieve the specific scope for the current nav item.
    … …  
    10781070    echo esc_url( bp_nouveau_get_nav_link() );
    10791071}
    1080 
    10811072    /**
    10821073     * Retrieve the URL for the current nav item.
    … …  
    11231114    echo esc_attr( bp_nouveau_get_nav_link_id() );
    11241115}
    1125 
    11261116    /**
    11271117     * Retrieve the id attribute of the link for the current nav item.
    … …  
    11661156    echo esc_attr( bp_nouveau_get_nav_link_title() );
    11671157}
    1168 
    11691158    /**
    11701159     * Retrieve the title attribute of the link for the current nav item.
    … …  
    12101199    echo esc_html( bp_nouveau_get_nav_link_text() );
    12111200}
    1212 
    12131201    /**
    12141202     * Retrieve the html text of the link for the current nav item.
    … …  
    12861274    echo esc_html( number_format_i18n( bp_nouveau_get_nav_count() ) );
    12871275}
    1288 
    12891276    /**
    12901277     * Retrieve the count attribute for the current nav item.
    … …  
    13391326    echo esc_attr( bp_nouveau_get_directory_type_navs_class() );
    13401327}
    1341 
    13421328    /**
    13431329     * Provides default nav wrapper classes.
    … …  
    13961382    echo esc_attr( bp_nouveau_get_directory_list_class() );
    13971383}
    1398 
    13991384    /**
    14001385     * Gets the directory nav item list class.
    … …  
    14201405    }
    14211406}
    1422 
    14231407    /**
    14241408     * Gets the directory nav item object.
    … …  
    15701554 *
    15711555 * @since 3.0.0
    1572  *
    1573  * @return string CSS classes
    15741556 */
    15751557function bp_nouveau_single_item_nav_classes() {
    15761558    echo esc_attr( bp_nouveau_get_single_item_nav_classes() );
    15771559}
    1578 
    15791560    /**
    15801561     * Returns the single item nav container classes
    … …  
    15821563     * @since 3.0.0
    15831564     *
    1584      * @return string CSS classes
     1565     * @return string CSS classes.
    15851566     */
    15861567    function bp_nouveau_get_single_item_nav_classes() {
    … …  
    16471628 *
    16481629 * @since 3.0.0
    1649  *
    1650  * @return string CSS classes
    16511630 */
    16521631function bp_nouveau_single_item_subnav_classes() {
    16531632    echo esc_attr( bp_nouveau_get_single_item_subnav_classes() );
    16541633}
    1655 
    16561634    /**
    16571635     * Returns the single item subnav container classes.
    … …  
    16591637     * @since 3.0.0
    16601638     *
    1661      * @return string CSS classes
     1639     * @return string CSS classes.
    16621640     */
    16631641    function bp_nouveau_get_single_item_subnav_classes() {
    … …  
    17071685 *
    17081686 * @since 3.0.0
    1709  *
    1710  * @return string CSS classes
    17111687 */
    17121688function bp_nouveau_groups_create_steps_classes() {
    17131689    echo esc_attr( bp_nouveau_get_group_create_steps_classes() );
    17141690}
    1715 
    17161691    /**
    17171692     * Returns the groups create steps customizer option choice class.
    … …  
    17191694     * @since 3.0.0
    17201695     *
    1721      * @return string CSS classes
     1696     * @return string CSS classes.
    17221697     */
    17231698    function bp_nouveau_get_group_create_steps_classes() {
    … …  
    17521727 * @since 3.0.0
    17531728 *
    1754  * @param string $object Optional. The primary object.
     1729 * @param string $object (Optional) The primary object.
    17551730 *
    17561731 * @return string The primary object.
    … …  
    17831758 * @since 3.0.0
    17841759 *
    1785  * @param array $objects Optional. The list of objects.
     1760 * @param array $objects (Optional) The list of objects.
    17861761 *
    17871762 * @return array The list of objects.
    … …  
    18671842 * @param string $suffix Optional. A string to append at the end of the ID.
    18681843 * @param string $sep    Optional. The separator to use between each token.
    1869  *
    1870  * @return string The selector ID.
    18711844 */
    18721845function bp_nouveau_search_selector_id( $suffix = '', $sep = '-' ) {
    … …  
    18821855 * @param  string $suffix Optional. A string to append at the end of the name.
    18831856 * @param  string $sep    Optional. The separator to use between each token.
    1884  *
    1885  * @return string The name attribute of a selector.
    18861857 */
    18871858function bp_nouveau_search_selector_name( $suffix = '', $sep = '_' ) {
    … …  
    19001871 * Output the default search text for the search object
    19011872 *
    1902  * @since 3.0.0
    1903  *
    1904  * @param  string $text    Optional. The default search text for the search object.
    1905  * @param  string $is_attr Optional. True if it's to be output inside an attribute. False Otherwise.
    1906  *
    1907  * @return string The default search text.
    1908  *
    19091873 * @todo 28/09/17 added  'empty( $text )' check to $object query as it wasn't returning output as expected & not returning user set params
    19101874 * This may require further examination - hnla
     1875 *
     1876 * @since 3.0.0
     1877 *
     1878 * @param  string $text    Optional. The default search text for the search object.
     1879 * @param  string $is_attr Optional. True if it's to be output inside an attribute. False otherwise.
    19111880 */
    19121881function bp_nouveau_search_default_text( $text = '', $is_attr = true ) {
    … …  
    20271996    }
    20281997}
    2029 
    20301998
    20311999// Template tags for the directory & user/group screen filters.
    … …  
    20982066    echo esc_attr( bp_nouveau_get_filter_container_id() );
    20992067}
    2100 
    21012068    /**
    21022069     * Get data filter container's ID attribute value.
    … …  
    21412108    echo esc_attr( bp_nouveau_get_filter_id() );
    21422109}
    2143 
    21442110    /**
    21452111     * Get data filter's ID attribute value.
    … …  
    21472113     * @since 3.0.0
    21482114     *
    2149      * @param string
     2115     * @return string
    21502116     */
    21512117    function bp_nouveau_get_filter_id() {
    … …  
    21842150    echo esc_html( bp_nouveau_get_filter_label() );
    21852151}
    2186 
    21872152    /**
    21882153     * Get data filter's label.
    … …  
    21902155     * @since 3.0.0
    21912156     *
    2192      * @param string
     2157     * @return string
    21932158     */
    21942159    function bp_nouveau_get_filter_label() {
Note: See TracChangeset for help on using the changeset viewer.