Changeset 9542

Timestamp:

02/23/2015 07:50:04 PM (10 years ago)

Author:

tw2113

Message:

Adds hooks documentation to bp-core-widgets.php.

See #5940.
Props jaimieolmstead.

File:

• trunk/src/bp-core/bp-core-widgets.php (modified) (4 diffs)

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

@@ -51 +51 @@
     public function widget( $args, $instance ) {
         $title = isset( $instance['title'] ) ? $instance['title'] : '';
+
+        /**
+         * Filters the title of the Login widget.
+         *
+         * @since BuddyPress (1.9.0)
+         *
+         * @param string $title The widget title.
+         */
         $title = apply_filters( 'widget_title', $title );
 
@@ -59 +67 @@
         <?php if ( is_user_logged_in() ) : ?>
 
-            <?php do_action( 'bp_before_login_widget_loggedin' ); ?>
+            <?php
+
+            /**
+             * Fires before the display of widget content if logged in.
+             *
+             * @since BuddyPress (1.9.0)
+             */
+            do_action( 'bp_before_login_widget_loggedin' ); ?>
 
             <div class="bp-login-widget-user-avatar">
@@ -72 +87 @@
             </div>
 
-            <?php do_action( 'bp_after_login_widget_loggedin' ); ?>
+            <?php
+
+            /**
+             * Fires after the display of widget content if logged in.
+             *
+             * @since BuddyPress (1.9.0)
+             */
+            do_action( 'bp_after_login_widget_loggedin' ); ?>
 
         <?php else : ?>
 
-            <?php do_action( 'bp_before_login_widget_loggedout' ); ?>
+            <?php
+
+            /**
+             * Fires before the display of widget content if logged out.
+             *
+             * @since BuddyPress (1.9.0)
+             */
+            do_action( 'bp_before_login_widget_loggedout' ); ?>
 
             <form name="bp-login-form" id="bp-login-widget-form" class="standard-form" action="<?php echo esc_url( site_url( 'wp-login.php', 'login_post' ) ); ?>" method="post">
@@ -97 +126 @@
             </form>
 
-            <?php do_action( 'bp_after_login_widget_loggedout' ); ?>
+            <?php
+
+            /**
+             * Fires after the display of widget content if logged out.
+             *
+             * @since BuddyPress (1.9.0)
+             */
+            do_action( 'bp_after_login_widget_loggedout' ); ?>
 
         <?php endif;