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/bp-core-filters.php

    r10825 r10899  
    309309     * @since 1.6.0
    310310     *
    311   * @param bool    $value           Whether or not to redirect.
     311    * @param bool    $value           Whether or not to redirect.
    312312     * @param string  $redirect_to     Sanitized URL to be redirected to.
    313313     * @param string  $redirect_to_raw Unsanitized URL to be redirected to.
     
    350350 * @param string $prop      Email property to check against.
    351351 * @param string $transform Either 'raw' or 'replace-tokens'.
     352 * @return string $retval Modified email content.
    352353 */
    353354function bp_email_plaintext_entity_decode( $retval, $prop, $transform ) {
     
    546547 * @global object $bp BuddyPress global settings.
    547548 *
    548  * @param  string $title       Original page title.
    549  * @param  string $sep         How to separate the various items within the page title.
    550  * @param  string $seplocation Direction to display title.
     549 * @param string $title       Original page title.
     550 * @param string $sep         How to separate the various items within the page title.
     551 * @param string $seplocation Direction to display title.
    551552 * @return string              New page title.
    552553 */
     
    596597     * Filters the older 'wp_title' page title for BuddyPress pages.
    597598     *
    598      * @since  1.5.0
    599      *
    600      * @param  string $new_title   The BuddyPress page title.
    601      * @param  string $title       The original WordPress page title.
    602      * @param  string $sep         The title parts separator.
    603      * @param  string $seplocation Location of the separator (left or right).
     599     * @since 1.5.0
     600     *
     601     * @param string $new_title   The BuddyPress page title.
     602     * @param string $title       The original WordPress page title.
     603     * @param string $sep         The title parts separator.
     604     * @param string $seplocation Location of the separator (left or right).
    604605     */
    605606    return apply_filters( 'bp_modify_page_title', $new_title, $title, $sep, $seplocation );
     
    649650     * Filters BuddyPress title parts that will be used into the document title.
    650651     *
    651      * @since  2.4.3
    652      *
    653      * @param  array $bp_title  The BuddyPress page title parts.
    654      * @param  array $title      The original WordPress title parts.
     652     * @since 2.4.3
     653     *
     654     * @param array $bp_title The BuddyPress page title parts.
     655     * @param array $title    The original WordPress title parts.
    655656     */
    656657    return apply_filters( 'bp_modify_document_title_parts', $bp_title, $title );
     
    750751 * Populate BuddyPress user nav items for the customizer.
    751752 *
    752  * @since  2.3.3
    753  *
    754  * @param  array   $items  The array of menu items.
    755  * @param  string  $type   The requested type.
    756  * @param  string  $object The requested object name.
    757  * @param  integer $page   The page num being requested.
    758  * @return array           The paginated BuddyPress user nav items.
     753 * @since 2.3.3
     754 *
     755 * @param array   $items  The array of menu items.
     756 * @param string  $type   The requested type.
     757 * @param string  $object The requested object name.
     758 * @param integer $page   The page num being requested.
     759 * @return array The paginated BuddyPress user nav items.
    759760 */
    760761function bp_customizer_nav_menus_get_items( $items = array(), $type = '', $object = '', $page = 0 ) {
     
    787788 * Set BuddyPress item navs for the customizer.
    788789 *
    789  * @since  2.3.3
    790  *
    791  * @param  array $item_types An associative array structured for the customizer.
     790 * @since 2.3.3
     791 *
     792 * @param array $item_types An associative array structured for the customizer.
    792793 * @return array $item_types An associative array structured for the customizer.
    793794 */
     
    853854 * @since 2.1.0
    854855 *
    855  * @param  string $edit_link The edit link.
    856  * @param  int    $post_id   Post ID.
     856 * @param string $edit_link The edit link.
     857 * @param int    $post_id   Post ID.
    857858 * @return bool|string Will be a boolean (false) if $post_id is 0. Will be a string (the unchanged edit link)
    858859 *                     otherwise
     
    900901 *
    901902 * @global array $wp_registered_widgets Current registered widgets.
    902  * @param  array $params                Current sidebar params.
     903 *
     904 * @param array $params Current sidebar params.
    903905 * @return array
    904906 */
     
    952954 * @since 2.5.0
    953955 *
    954  * @param string $value Property value.
    955  * @param string $property_name
    956  * @param string $transform How the return value was transformed.
     956 * @param string $value         Property value.
     957 * @param string $property_name Email template property name.
     958 * @param string $transform     How the return value was transformed.
    957959 * @return string Updated value.
    958960 */
     
    991993 * @since 2.5.0
    992994 *
    993  * @param array $headers
    994  * @param string $property Name of property. Unused.
    995  * @param string $transform Return value transformation. Unused.
    996  * @param BP_Email $email Email object reference.
     995 * @param array    $headers   Array of email headers.
     996 * @param string   $property Name of property. Unused.
     997 * @param string   $transform Return value transformation. Unused.
     998 * @param BP_Email $email     Email object reference.
    997999 * @return array
    9981000 */
     
    10101012 * @since 2.5.0
    10111013 *
    1012  * @param array $tokens Email tokens.
    1013  * @param string $property_name Unused.
    1014  * @param string $transform Unused.
    1015  * @param BP_Email $email Email being sent.
     1014 * @param array    $tokens        Email tokens.
     1015 * @param string   $property_name Unused.
     1016 * @param string   $transform    Unused.
     1017 * @param BP_Email $email         Email being sent.
    10161018 * @return array
    10171019 */
Note: See TracChangeset for help on using the changeset viewer.