Skip to:
Content

BuddyPress.org

Changeset 12481


Ignore:
Timestamp:
10/24/2019 01:17:50 AM (4 years ago)
Author:
johnjamesjacoby
Message:

Docs: fix typos and code comments gone rogue.

This commit fixes a few random typos and weirdly misplaced code comments I stumbled across in the Core Functions file while looking at something else entirely. 🐿

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/bp-core/bp-core-functions.php

    r12434 r12481  
    1717 *
    1818 * @since 1.6.0
    19  *
    2019 */
    2120function bp_version() {
     
    3736 *
    3837 * @since 1.6.0
    39  *
    4038 */
    4139function bp_db_version() {
     
    5755 *
    5856 * @since 1.6.0
    59  *
    6057 */
    6158function bp_db_version_raw() {
     
    237234 * @since 1.6.0
    238235 *
    239  * @param array $old_args_keys Old argument indexs, keyed to their positions.
     236 * @param array $old_args_keys Old argument indexes, keyed to their positions.
    240237 * @param array $func_args     The parameters passed to the originating function.
    241238 * @return array $new_args The parsed arguments.
     
    322319 * Sanitizes a pagination argument based on both the request override and the
    323320 * original value submitted via a query argument, likely to a template class
    324  * responsible for limiting the resultset of a template loop.
     321 * responsible for limiting the result set of a template loop.
    325322 *
    326323 * @since 2.2.0
     
    14231420 *
    14241421 * @since 1.1.0
    1425  *
    14261422 */
    14271423function bp_core_setup_message() {
     
    15071503 * @since 1.0.0
    15081504 *
    1509  *       usermeta table.
    1510  *
    15111505 * @return false|null Returns false if there is nothing to do.
    15121506 */
     
    15641558 * @since 1.0.0
    15651559 *
    1566  *       representation of the time elapsed.
    1567  *
    15681560 * @param int|string $last_activity_date The date of last activity.
    15691561 * @param string     $string             A sprintf()-able statement of the form 'active %s'.
     
    15991591 * Get the meta_key for a given piece of user metadata
    16001592 *
    1601  * BuddyPress stores a number of pieces of userdata in the WordPress central
     1593 * BuddyPress stores a number of pieces of user data in the WordPress central
    16021594 * usermeta table. In order to allow plugins to enable multiple instances of
    16031595 * BuddyPress on a single WP installation, BP's usermeta keys are filtered
     
    31113103 * @param string                   $email_type Type of email being sent.
    31123104 * @param string|array|int|WP_User $to         Either a email address, user ID, WP_User object,
    3113  *                                             or an array containg the address and name.
     3105 *                                             or an array containing the address and name.
    31143106 * @param array                    $args {
    31153107 *     Optional. Array of extra parameters.
    31163108 *
    3117  *     @type array $tokens Optional. Assocative arrays of string replacements for the email.
     3109 *     @type array $tokens Optional. Associative arrays of string replacements for the email.
    31183110 * }
    31193111 * @return bool|WP_Error True if the email was sent successfully. Otherwise, a WP_Error object
     
    31673159     * @param string                   $email_type Type of email being sent.
    31683160     * @param string|array|int|WP_User $to         Either a email address, user ID, WP_User object,
    3169      *                                             or an array containg the address and name.
     3161     *                                             or an array containing the address and name.
    31703162     * @param array                    $args {
    31713163     *     Optional. Array of extra parameters.
     
    32213213     *     Optional. Array of extra parameters.
    32223214     *
    3223      *     @type array $tokens Optional. Assocative arrays of string replacements for the email.
     3215     *     @type array $tokens Optional. Associative arrays of string replacements for the email.
    32243216     * }
    32253217     */
     
    32483240
    32493241        /**
    3250          * Fires after BuddyPress has succesfully sent an email.
     3242         * Fires after BuddyPress has successfully sent an email.
    32513243         *
    32523244         * @since 2.5.0
Note: See TracChangeset for help on using the changeset viewer.