Changeset 50505 for trunk/src/wp-admin/theme-install.php

Timestamp:

03/07/2021 12:30:38 PM (4 years ago)

Author:

johnbillion

Message:

Docs: Add examples of possible names for various hooks whose name contains a dynamic portion.

This provides greater discoverability of such hooks in search results on the Code Reference site as well as increased clarity when reading the source.

See #50734, #52628

File:

• trunk/src/wp-admin/theme-install.php (modified) (2 diffs)

trunk/src/wp-admin/theme-install.php

@@ -85 +85 @@
      *
      * The dynamic portion of the hook name, `$tab`, refers to the current
-     * theme installation tab. Possible values are 'dashboard', 'search', 'upload',
-     * 'featured', 'new', or 'updated'.
+     * theme installation tab.
+     *
+     * Possible hook names include:
+     *
+     *  - `install_themes_pre_dashboard`
+     *  - `install_themes_pre_featured`
+     *  - `install_themes_pre_new`
+     *  - `install_themes_pre_search`
+     *  - `install_themes_pre_updated`
+     *  - `install_themes_pre_upload`
      *
      * @since 2.8.0
@@ -252 +260 @@
      *
      * The dynamic portion of the hook name, `$tab`, refers to the current
-     * theme installation tab. Possible values are 'dashboard', 'search', 'upload',
-     * 'featured', 'new', or 'updated'.
+     * theme installation tab.
+     *
+     * Possible hook names include:
+     *
+     *  - `install_themes_dashboard`
+     *  - `install_themes_featured`
+     *  - `install_themes_new`
+     *  - `install_themes_search`
+     *  - `install_themes_updated`
+     *  - `install_themes_upload`
      *
      * @since 2.8.0