Changeset 30649 for trunk/src/wp-admin/admin.php

Timestamp:

11/30/2014 11:42:00 AM (10 years ago)

Author:

DrewAPicture

Message:

Docs Formatting: Backtick-escape inline code for all dynamic hook docs in wp-admin/*.

Also includes some changes to move hook docs to directly precede hook lines. This is necessary to prevent DocBlock-matching confusion when core is parsed.

Affects DocBlocks for the following hooks:

• wp_ajax_ . $_REQUEST['action']
• wp_ajax_nopriv_ . $_REQUEST['action']
• admin_footer- . $GLOBALS['hook_suffix']
• admin_head-$hook_suffix
• admin_post_nopriv_{$action}
• admin_post_{$action}
• load- . $page_hook
• load- . $plugin_page
• load-importer- . $importer
• load- . $pagenow
• admin_action_ . $_REQUEST['action']
• async_upload_{$type}
• add_meta_boxes_ . $post_type
• {$taxonomy}_pre_edit_form
• {$taxonomy}_term_edit_form_tag
• {$taxonomy}_edit_form_fields
• {$taxonomy}_edit_form
• after-{$taxonomy}-table
• {$taxonomy}_pre_add_form
• {$taxonomy}_term_new_form_tag
• {$taxonomy}_add_form_fields
• {$taxonomy}_add_form
• media_upload_$type
• media_upload_$tab
• install_plugins_pre_$tab
• install_plugins_$tab
• install_themes_pre_{$tab}
• install_themes_{$tab}
• update-core-custom_{$action}
• update-custom_{$action}
• user_{$name}_label

See #30552.

File:

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

trunk/src/wp-admin/admin.php

@@ -186 +186 @@
          * where a callback is provided when the screen is registered.
          *
-         * The dynamic portion of the hook name, $page_hook, refers to a mixture of plugin
+         * The dynamic portion of the hook name, `$page_hook`, refers to a mixture of plugin
          * page information including:
          * 1. The page type. If the plugin page is registered as a submenu page, such as for
@@ -193 +193 @@
          * 3. The plugin basename minus the file extension.
          *
-         * Together, the three parts form the $page_hook. Citing the example above,
+         * Together, the three parts form the `$page_hook`. Citing the example above,
          * the hook name used would be 'load-settings_page_pluginbasename'.
          *
@@ -224 +224 @@
          * where the file to load is directly included, rather than the use of a function.
          *
-         * The dynamic portion of the hook name, $plugin_page, refers to the plugin basename.
+         * The dynamic portion of the hook name, `$plugin_page`, refers to the plugin basename.
          *
          * @see plugin_basename()
@@ -264 +264 @@
      * Fires before an importer screen is loaded.
      *
-     * The dynamic portion of the hook name, $importer, refers to the importer slug.
+     * The dynamic portion of the hook name, `$importer`, refers to the importer slug.
      *
      * @since 3.5.0
@@ -309 +309 @@
      * The load-* hook fires in a number of contexts. This hook is for core screens.
      *
-     * The dynamic portion of the hook name, $pagenow, is a global variable
+     * The dynamic portion of the hook name, `$pagenow`, is a global variable
      * referring to the filename of the current page, such as 'admin.php',
      * 'post-new.php' etc. A complete hook for the latter would be
@@ -339 +339 @@
      * Fires when an 'action' request variable is sent.
      *
-     * The dynamic portion of the hook name, $_REQUEST['action'],
-     * refers to the action derived from the GET or POST request.
+     * The dynamic portion of the hook name, `$_REQUEST['action']`,
+     * refers to the action derived from the `GET` or `POST` request.
      *
      * @since 2.6.0