Changeset 25252 for trunk/src/wp-admin/admin-footer.php

Timestamp:

09/05/2013 04:20:05 PM (11 years ago)

Author:

nacin

Message:

Hook docs for admin-footer.php.

props natejacobs.
see #25229.

File:

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

trunk/src/wp-admin/admin-footer.php

@@ -17 +17 @@
 
 <div id="wpfooter">
-<?php do_action( 'in_admin_footer' ); ?>
-<p id="footer-left" class="alignleft"><?php
-echo apply_filters( 'admin_footer_text', '<span id="footer-thankyou">' . __( 'Thank you for creating with <a href="http://wordpress.org/">WordPress</a>.' ) . '</span>' );
-?></p>
-<p id="footer-upgrade" class="alignright"><?php echo apply_filters( 'update_footer', '' ); ?></p>
-<div class="clear"></div>
+    <?php
+    /**
+     * Fires after the opening tag for the admin footer.
+     *
+     * @since 2.5.0
+     */ 
+    do_action( 'in_admin_footer' ); 
+    ?>
+    <p id="footer-left" class="alignleft">
+        <?php
+        /**
+         * Filter the "Thank you" text displayed in the admin footer
+         * 
+         * @since 2.8.0
+         * @param string The content that will be printed.
+         */ 
+        echo apply_filters( 'admin_footer_text', '<span id="footer-thankyou">' . __( 'Thank you for creating with <a href="http://wordpress.org/">WordPress</a>.' ) . '</span>' );
+        ?>
+    </p>
+    <p id="footer-upgrade" class="alignright">
+        <?php
+        /**
+         * Filter the version/update text displayed in the admin footer
+         *
+         * @see core_update_footer() WordPress prints the current version and update information,
+         *  using core_update_footer() at priority 10.
+         * 
+         * @since 2.5.0
+         * @param string The content that will be printed.
+         */
+        echo apply_filters( 'update_footer', '' ); 
+        ?>
+    </p>
+    <div class="clear"></div>
 </div>
 <?php
+/**
+ * Print scripts or data before the default footer scripts
+ * 
+ * @since 2.5.0
+ * @param string The data to print.
+ */
 do_action('admin_footer', '');
+
+/**
+ * Prints any scripts and data queued for the footer
+ * 
+ * @since 2.8.0
+ */
 do_action('admin_print_footer_scripts');
+
+/**
+ * Print scripts or data after the default footer scripts
+ * 
+ * @since unknown
+ * 
+ * @param type $GLOBALS['hook_suffix'] The current admin page.
+ */
 do_action("admin_footer-" . $GLOBALS['hook_suffix']);