Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
06/23/2016 06:31:58 AM (8 years ago)
Author:
tw2113
Message:

Many PHPDocs cleanup for Core component.

See #6398.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/bp-core/classes/class-bp-core-nav.php

    r10873 r10899  
    55 * @package BuddyPress
    66 * @subpackage Core
    7  * @since  2.6.0
     7 * @since 2.6.0
    88 */
    99
     
    5757     * @since 2.6.0
    5858     *
    59      * @param  string $key The requested nav slug.
     59     * @param string $key The requested nav slug.
    6060     * @return bool True if the nav item is set, false otherwise.
    6161     */
     
    6969     * @since 2.6.0
    7070     *
    71      * @param  string $key The requested nav slug.
     71     * @param string $key The requested nav slug.
    7272     * @return mixed The value corresponding to the requested nav item.
    7373     */
     
    8585     * @since 2.6.0
    8686     *
    87      * @param  string $key   The requested nav slug.
    88      * @param  mixed   $value The value of the nav item.
     87     * @param string $key   The requested nav slug.
     88     * @param mixed  $value The value of the nav item.
    8989     */
    9090    public function __set( $key, $value ) {
     
    101101     * @since 2.6.0
    102102     *
    103      * @param  string $key The nav item slug to get. Optional.
     103     * @param string $key The nav item slug to get. Optional.
    104104     * @return mixed       An array of nav item, a single nav item, or null if none found.
    105105     */
     
    321321     * @since 2.6.0
    322322     *
    323      * @param  array $args Filters to select the specific primary items. See wp_list_filter().
    324      * @param  bool  $sort True to sort the nav items. False otherwise.
     323     * @param array $args Filters to select the specific primary items. See wp_list_filter().
     324     * @param bool  $sort True to sort the nav items. False otherwise.
    325325     * @return array The list of primary objects nav
    326326     */
     
    328328        $params = wp_parse_args( $args, array( 'primary' => true ) );
    329329
    330         // This parameter is not overridable
     330        // This parameter is not overridable.
    331331        if ( empty( $params['primary'] ) ) {
    332332            return false;
     
    351351     * @since 2.6.0
    352352     *
    353      * @param  array $args Filters to select the specific secondary items. See wp_list_filter().
    354      * @param  bool  $sort True to sort the nav items. False otherwise.
     353     * @param array $args Filters to select the specific secondary items. See wp_list_filter().
     354     * @param bool  $sort True to sort the nav items. False otherwise.
    355355     * @return array The list of secondary objects nav
    356356     */
     
    358358        $params = wp_parse_args( $args, array( 'parent_slug' => '' ) );
    359359
    360         // No need to search children if the parent is not set
     360        // No need to search children if the parent is not set.
    361361        if ( empty( $params['parent_slug'] ) && empty( $params['secondary'] ) ) {
    362362            return false;
     
    388388        if ( $primary_nav_items ) {
    389389            foreach( $primary_nav_items as $key_nav => $primary_nav ) {
    390                 // Try to get the children
     390                // Try to get the children.
    391391                $children = $this->get_secondary( array( 'parent_slug' => $primary_nav->slug, 'user_has_access' => true ) );
    392392
Note: See TracChangeset for help on using the changeset viewer.