Changeset 9664 for trunk/src/bp-core/bp-core-filters.php

Timestamp:

03/31/2015 04:19:19 AM (12 years ago)

Author:

tw2113

Message:

Adds hooks documentation for bp-core-filters.php and bp-core-catchuri.php, fixes version number.

See #5940.

File:

• trunk/src/bp-core/bp-core-filters.php (modified) (9 diffs)

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

@@ -95 +95 @@
                 $pages[] = $bp->pages->forums->id;
 
+        /**
+         * Filters specific pages that shouldn't show up on page listings.
+         *
+         * @since BuddyPress (1.5.0)
+         *
+         * @param array $pages Array of pages to exclude.
+         */
         return apply_filters( 'bp_core_exclude_pages', $pages );
 }
@@ -235 +242 @@
  */
 function bp_core_email_from_name_filter() {
+
+        /**
+         * Filters the "From" name in outgoing email to the site name.
+         *
+         * @since BuddyPress (1.2.0)
+         *
+         * @param string $value Value to set the "From" name to.
+         */
         return apply_filters( 'bp_core_email_from_name_filter', bp_get_option( 'blogname', 'WordPress' ) );
 }
@@ -301 +316 @@
         }
 
-        // Allow plugins to allow or disallow redirects, as desired
+        /**
+         * Filters whether or not to redirect.
+         *
+         * Allows plugins to have finer grained control of redirect upon login.
+         *
+         * @since BuddyPress (1.6.0)
+         *
+    * @param bool    $value           Whether or not to redirect.
+         * @param string  $redirect_to     Sanitized URL to be redirected to.
+         * @param string  $redirect_to_raw Unsanitized URL to be redirected to.
+         * @param WP_User $user            The WP_User object corresponding to a
+         *                                 successfully logged in user.
+         */
         $maybe_redirect = apply_filters( 'bp_core_login_redirect', false, $redirect_to, $redirect_to_raw, $user );
         if ( false !== $maybe_redirect ) {
@@ -318 +345 @@
         }
 
+        /**
+         * Filters the URL to redirect users to upon successful login.
+         *
+         * @since BuddyPress (1.9.0)
+         *
+         * @param string $value URL to redirect to.
+         */
         return apply_filters( 'bp_core_login_redirect_to', bp_get_root_domain() );
 }
@@ -415 +449 @@
         $subject = bp_get_email_subject( array( 'text' => sprintf( __( 'Activate %s', 'buddypress' ), 'http://' . $domain . $path ) ) );
 
-        // Email filters
+        /**
+         * Filters the email that the notification is going to upon successful registration with blog.
+         *
+         * @since BuddyPress (1.2.0)
+         *
+         * @param string $user_email The user's email address.
+         * @param string $domain     The new blog domain.
+         * @param string $path       The new blog path.
+         * @param string $title      The site title.
+         * @param string $user       The user's login name.
+         * @param string $user_email The user's email address.
+         * @param string $key        The activation key created in wpmu_signup_blog().
+         * @param array  $meta       Array of meta values for the created site.
+         */
         $to      = apply_filters( 'bp_core_activation_signup_blog_notification_to',   $user_email, $domain, $path, $title, $user, $user_email, $key, $meta );
+
+        /**
+         * Filters the subject that the notification uses upon successful registration with blog.
+         *
+         * @since BuddyPress (1.2.0)
+         *
+         * @param string $subject    The subject to use.
+         * @param string $domain     The new blog domain.
+         * @param string $path       The new blog path.
+         * @param string $title      The site title.
+         * @param string $user       The user's login name.
+         * @param string $user_email The user's email address.
+         * @param string $key        The activation key created in wpmu_signup_blog().
+         * @param array  $meta       Array of meta values for the created site.
+         */
         $subject = apply_filters( 'bp_core_activation_signup_blog_notification_subject', $subject, $domain, $path, $title, $user, $user_email, $key, $meta );
+
+        /**
+         * Filters the message that the notification uses upon successful registration with blog.
+         *
+         * @since BuddyPress (1.2.0)
+         *
+         * @param string $message    The message to use.
+         * @param string $domain     The new blog domain.
+         * @param string $path       The new blog path.
+         * @param string $title      The site title.
+         * @param string $user       The user's login name.
+         * @param string $user_email The user's email address.
+         * @param string $key        The activation key created in wpmu_signup_blog().
+         * @param array  $meta       Array of meta values for the created site.
+         */
         $message = apply_filters( 'bp_core_activation_signup_blog_notification_message', $message, $domain, $path, $title, $user, $user_email, $key, $meta );
 
@@ -426 +503 @@
         $admin_email = bp_get_option( 'admin_email' );
 
+        /**
+         * Fires after the sending of the notification to new users for successful registration with blog.
+         *
+         * @since BuddyPress (1.5.0)
+         *
+         * @param string $admin_email Admin Email address for the site.
+         * @param string $subject     Subject used in the notification email.
+         * @param string $message     Message used in the notification email.
+         * @param string domain       The new blog domain.
+         * @param string $path        The new blog path.
+         * @param string $title       The site title.
+         * @param string $user        The user's login name.
+         * @param string $user_email  The user's email address.
+         * @param string $key         The activation key created in wpmu_signup_blog().
+         * @param array  $meta        Array of meta values for the created site.
+         */
         do_action( 'bp_core_sent_blog_signup_email', $admin_email, $subject, $message, $domain, $path, $title, $user, $user_email, $key, $meta );
 
@@ -480 +573 @@
         $subject = bp_get_email_subject( array( 'text' => __( 'Activate Your Account', 'buddypress' ) ) );
 
-        // Email filters
+        /**
+         * Filters the email that the notification is going to upon successful registration without blog.
+         *
+         * @since BuddyPress (1.2.0)
+         *
+         * @param string $user_email The user's email address.
+         * @param string $user       The user's login name.
+         * @param string $user_email The user's email address.
+         * @param string $key        The activation key created in wpmu_signup_blog().
+         * @param array  $meta       Array of meta values for the created site.
+         */
         $to      = apply_filters( 'bp_core_activation_signup_user_notification_to',   $user_email, $user, $user_email, $key, $meta );
+
+        /**
+         * Filters the subject that the notification uses upon successful registration without blog.
+         *
+         * @since BuddyPress (1.2.0)
+         *
+         * @param string $subject    The subject to use.
+         * @param string $user       The user's login name.
+         * @param string $user_email The user's email address.
+         * @param string $key        The activation key created in wpmu_signup_blog().
+         * @param array  $meta       Array of meta values for the created site.
+         */
         $subject = apply_filters( 'bp_core_activation_signup_user_notification_subject', $subject, $user, $user_email, $key, $meta );
+
+        /**
+         * Filters the message that the notification uses upon successful registration without blog.
+         *
+         * @since BuddyPress (1.2.0)
+         *
+         * @param string $message    The message to use.
+         * @param string $user       The user's login name.
+         * @param string $user_email The user's email address.
+         * @param string $key        The activation key created in wpmu_signup_blog().
+         * @param array  $meta       Array of meta values for the created site.
+         */
         $message = apply_filters( 'bp_core_activation_signup_user_notification_message', $message, $user, $user_email, $key, $meta );
 
@@ -491 +618 @@
         $admin_email = bp_get_option( 'admin_email' );
 
+        /**
+         * Fires after the sending of the notification to new users for successful registration without blog.
+         *
+         * @since BuddyPress (1.5.0)
+         *
+         * @param string $admin_email Admin Email address for the site.
+         * @param string $subject     Subject used in the notification email.
+         * @param string $message     Message used in the notification email.
+         * @param string $user        The user's login name.
+         * @param string $user_email  The user's email address.
+         * @param string $key         The activation key created in wpmu_signup_blog().
+         * @param array  $meta        Array of meta values for the created site. Default empty array.
+         */
         do_action( 'bp_core_sent_user_signup_email', $admin_email, $subject, $message, $user, $user_email, $key, $meta );
 
@@ -624 +764 @@
         $title = preg_replace( '|<span>[0-9]+</span>|', '', $title );
 
+        /**
+         * Filters the page title for BuddyPress pages.
+         *
+         * @since BuddyPress (1.5.0)
+         *
+         * @param string $value       Determined title for the current BuddyPress page.
+         * @param string $sep         Separator used for the BuddyPress page title.
+         * @param string $seplocation Location to place the separator value.
+         */
         return apply_filters( 'bp_modify_page_title', $title . ' ' . $sep . ' ', $title, $sep, $seplocation );
 }