Changeset 25250 for trunk/src/wp-admin/index.php

Timestamp:

09/05/2013 04:06:16 PM (13 years ago)

Author:

nacin

Message:

Inline documentation for the welcome_panel hook.

props natejacobs.
see #25229.

File:

• trunk/src/wp-admin/index.php (modified) (1 diff)

trunk/src/wp-admin/index.php

@@ -121 +121 @@
                 <?php wp_nonce_field( 'welcome-panel-nonce', 'welcomepanelnonce', false ); ?>
                 <a class="welcome-panel-close" href="<?php echo esc_url( admin_url( '?welcome=0' ) ); ?>"><?php _e( 'Dismiss' ); ?></a>
-                <?php do_action( 'welcome_panel' ); ?>
+                <?php
+                /**
+                 * Add content to the welcome panel on the admin dashboard
+                 * 
+                 * To remove the default welcome panel, use remove_action():
+                 * <code>remove_action( 'welcome_panel', 'wp_welcome_panel' );</code>
+                 * 
+                 * @since 3.5.0
+                 */
+                do_action( 'welcome_panel' ); 
+                ?>
         </div>
 <?php endif; ?>