Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
07/12/2015 12:49:36 AM (9 years ago)
Author:
tw2113
Message:

First pass at BP-Core docs cleanup.

See #6398.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/bp-core/bp-core-filters.php

    r9848 r10012  
    7575 *
    7676 * @param array $pages List of excluded page IDs, as passed to the
    77  *        'wp_list_pages_excludes' filter.
     77 *                     'wp_list_pages_excludes' filter.
     78 *
    7879 * @return array The exclude list, with BP's pages added.
    7980 */
    … …  
    114115 * @uses buddypress() gets BuddyPress main instance
    115116 *
    116  * @param object $object The post type object used in the meta box
    117  * @return object The $object, with a query argument to remove register and activate pages id.
     117 * @param object|null $object The post type object used in the meta box.
     118 *
     119 * @return object|null The $object, with a query argument to remove register and activate pages id.
    118120 */
    119121function bp_core_exclude_pages_from_nav_menu_admin( $object = null ) {
    … …  
    157159 * @since BuddyPress (2.2.0)
    158160 *
    159  * @param array   $retval CSS classes for the current menu page in the menu
    160  * @param WP_Post $page   The page properties for the current menu item
     161 * @param array   $retval CSS classes for the current menu page in the menu.
     162 * @param WP_Post $page   The page properties for the current menu item.
     163 *
    161164 * @return array
    162165 */
    … …  
    214217 * @since BuddyPress (2.2.0)
    215218 *
    216  * @param array   $retval CSS classes for the current nav menu item in the menu
    217  * @param WP_Post $item   The properties for the current nav menu item
     219 * @param array   $retval CSS classes for the current nav menu item in the menu.
     220 * @param WP_Post $item   The properties for the current nav menu item.
     221 *
    218222 * @return array
    219223 */
    … …  
    258262 *
    259263 * @param array $comments The array of comments supplied to the comments template.
    260  * @param int $post->ID The post ID.
     264 * @param int   $post_id  The post ID.
     265 *
    261266 * @return array $comments The modified comment array.
    262267 */
    … …  
    297302 *       are redirected to on login.
    298303 *
    299  * @param string $redirect_to The URL to be redirected to, sanitized
    300  *        in wp-login.php.
    301  * @param string $redirect_to_raw The unsanitized redirect_to URL ($_REQUEST['redirect_to'])
    302  * @param WP_User $user The WP_User object corresponding to a successfully
    303  *        logged-in user. Otherwise a WP_Error object.
     304 * @param string  $redirect_to     The URL to be redirected to, sanitized in wp-login.php.
     305 * @param string  $redirect_to_raw The unsanitized redirect_to URL ($_REQUEST['redirect_to']).
     306 * @param WP_User $user            The WP_User object corresponding to a successfully
     307 *                                 logged-in user. Otherwise a WP_Error object.
     308 *
    304309 * @return string The redirect URL.
    305310 */
    … …  
    323328     * @since BuddyPress (1.6.0)
    324329     *
    325     * @param bool    $value           Whether or not to redirect.
     330  * @param bool    $value           Whether or not to redirect.
    326331     * @param string  $redirect_to     Sanitized URL to be redirected to.
    327332     * @param string  $redirect_to_raw Unsanitized URL to be redirected to.
    … …  
    366371 *
    367372 * @param string $welcome_email Complete email passed through WordPress.
     373 *
    368374 * @return string Filtered $welcome_email with the password replaced
    369  *         by '[User Set]'.
     375 *                by '[User Set]'.
    370376 */
    371377function bp_core_filter_user_welcome_email( $welcome_email ) {
    … …  
    400406 *
    401407 * @param string $welcome_email Complete email passed through WordPress.
    402  * @param int $blog_id ID of the blog user is joining.
    403  * @param int $user_id ID of the user joining.
    404  * @param string $password Password of user.
     408 * @param int    $blog_id       ID of the blog user is joining.
     409 * @param int    $user_id       ID of the user joining.
     410 * @param string $password      Password of user.
     411 *
    405412 * @return string Filtered $welcome_email with $password replaced by '[User Set]'.
    406413 */
    … …  
    429436 * @see wpmu_signup_blog_notification() for a description of parameters.
    430437 *
    431  * @param string $domain The new blog domain.
    432  * @param string $path The new blog path.
    433  * @param string $title The site title.
    434  * @param string $user The user's login name.
     438 * @param string $domain     The new blog domain.
     439 * @param string $path       The new blog path.
     440 * @param string $title      The site title.
     441 * @param string $user       The user's login name.
    435442 * @param string $user_email The user's email address.
    436  * @param string $key The activation key created in wpmu_signup_blog()
    437  * @param array $meta By default, contains the requested privacy setting and
    438  *        lang_id.
     443 * @param string $key        The activation key created in wpmu_signup_blog()
     444 * @param array  $meta       By default, contains the requested privacy setting and
     445 *                           lang_id.
     446 *
    439447 * @return bool True on success, false on failure.
    440448 */
    … …  
    511519     * @param string $subject     Subject used in the notification email.
    512520     * @param string $message     Message used in the notification email.
    513      * @param string domain       The new blog domain.
     521     * @param string $domain      The new blog domain.
    514522     * @param string $path        The new blog path.
    515523     * @param string $title       The site title.
    … …  
    531539 * @see wpmu_signup_user_notification() for a full description of params.
    532540 *
    533  * @param string $user The user's login name.
     541 * @param string $user       The user's login name.
    534542 * @param string $user_email The user's email address.
    535  * @param string $key The activation key created in wpmu_signup_user()
    536  * @param array $meta By default, an empty array.
    537  * @return bool True on success, false on failure.
     543 * @param string $key        The activation key created in wpmu_signup_user()
     544 * @param array  $meta       By default, an empty array.
     545 *
     546 * @return bool|string True on success, false on failure.
    538547 */
    539548function bp_core_activation_signup_user_notification( $user, $user_email, $key, $meta ) {
    … …  
    825834 *
    826835 * @param  string $title_part
     836 *
    827837 * @return string
    828838 */
    … …  
    842852 *
    843853 * @param WP_Post $menu_item The menu item.
    844  * @return obj The modified WP_Post object.
     854 *
     855 * @return WP_Post The modified WP_Post object.
    845856 */
    846857function bp_setup_nav_menu_item( $menu_item ) {
    … …  
    927938 *
    928939 * @param string $q SQL query.
     940 *
    929941 * @return string
    930942 */
    … …  
    952964
    953965/**
    954  * Filter the edit post link to avoid its display in BuddyPress pages
     966 * Filter the edit post link to avoid its display in BuddyPress pages.
    955967 *
    956968 * @since BuddyPress (2.1.0)
    … …  
    958970 * @param  string $edit_link The edit link.
    959971 * @param  int    $post_id   Post ID.
    960  * @return mixed  Will be a boolean (false) if $post_id is 0. Will be a string (the unchanged edit link)
    961  *                otherwise
     972 *
     973 * @return bool|string Will be a boolean (false) if $post_id is 0. Will be a string (the unchanged edit link)
     974 *                     otherwise
    962975 */
    963976function bp_core_filter_edit_post_link( $edit_link = '', $post_id = 0 ) {
    … …  
    973986 * mentions suggestions?
    974987 *
    975  * @param bool $load_mentions True to load mentions assets, false otherwise.
     988 * @since BuddyPress (2.2.0)
     989 *
     990 * @param bool $load_mentions    True to load mentions assets, false otherwise.
    976991 * @param bool $mentions_enabled True if mentions are enabled.
     992 *
    977993 * @return bool True if mentions scripts should be loaded.
    978  * @since BuddyPress (2.2.0)
    979994 */
    980995function bp_maybe_load_mentions_scripts_for_blog_content( $load_mentions, $mentions_enabled ) {
Note: See TracChangeset for help on using the changeset viewer.