Changeset 27145

Timestamp:

02/09/2014 08:28:01 PM (10 years ago)

Author:

DrewAPicture

Message:

Fixes for hooks documentation in wp-admin/admin-footer.php.

Adds some new lines, some hook-line spacing, docs-specific variables, and other language tweaks.

See #26869, #25229, [25252].

File:

• trunk/src/wp-admin/admin-footer.php (modified) (4 diffs)

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

@@ -31 +31 @@
          *
          * @since 2.8.0
-         * @param string The content that will be printed.
+         *
+         * @param string $text 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>' );
@@ -41 +42 @@
          * 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.
+         * WordPress prints the current version and update information,
+         * using core_update_footer() at priority 10.
          *
          * @since 2.3.0
-         * @param string The content that will be printed.
+         *
+         * @see core_update_footer()
+         *
+         * @param string $content The content that will be printed.
          */
         echo apply_filters( 'update_footer', '' );
@@ -57 +61 @@
  *
  * @since 1.2.0
- * @param string The data to print.
+ *
+ * @param string $data The data to print.
  */
-do_action('admin_footer', '');
+do_action( 'admin_footer', '' );
 
 /**
@@ -66 +71 @@
  * @since 2.8.0
  */
-do_action('admin_print_footer_scripts');
+do_action( 'admin_print_footer_scripts' );
 
 /**
  * Print scripts or data after the default footer scripts.
  *
+ * The dynamic portion of the hook name, $GLOBALS['hook_suffix'],
+ * refers to the global hook suffix of the current page.
+ *
  * @since 2.8.0
  *
- * @param string $GLOBALS['hook_suffix'] The current admin page.
+ * @param string $hook_suffix The current admin page.
  */
-do_action("admin_footer-" . $GLOBALS['hook_suffix']);
+do_action( "admin_footer-" . $GLOBALS['hook_suffix'] );
 
 // get_site_option() won't exist when auto upgrading from <= 2.7