Changeset 50505 for trunk/src/wp-includes/link-template.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-includes/link-template.php (modified) (6 diffs)

trunk/src/wp-includes/link-template.php

@@ -1812 +1812 @@
      * of adjacency, 'next' or 'previous'.
      *
+     * Possible hook names include:
+     *
+     *  - `get_next_post_excluded_terms`
+     *  - `get_previous_post_excluded_terms`
+     *
      * @since 4.4.0
      *
@@ -1883 +1888 @@
      * of adjacency, 'next' or 'previous'.
      *
+     * Possible hook names include:
+     *
+     *  - `get_next_post_join`
+     *  - `get_previous_post_join`
+     *
      * @since 2.5.0
      * @since 4.4.0 Added the `$taxonomy` and `$post` parameters.
@@ -1900 +1910 @@
      * of adjacency, 'next' or 'previous'.
      *
+     * Possible hook names include:
+     *
+     *  - `get_next_post_where`
+     *  - `get_previous_post_where`
+     *
      * @since 2.5.0
      * @since 4.4.0 Added the `$taxonomy` and `$post` parameters.
@@ -1916 +1931 @@
      * The dynamic portion of the hook name, `$adjacent`, refers to the type
      * of adjacency, 'next' or 'previous'.
+     *
+     * Possible hook names include:
+     *
+     *  - `get_next_post_sort`
+     *  - `get_previous_post_sort`
      *
      * @since 2.5.0
@@ -2004 +2024 @@
      * The dynamic portion of the hook name, `$adjacent`, refers to the type
      * of adjacency, 'next' or 'previous'.
+     *
+     * Possible hook names include:
+     *
+     *  - `next_post_rel_link`
+     *  - `previous_post_rel_link`
      *
      * @since 2.8.0
@@ -2261 +2286 @@
      * The dynamic portion of the hook name, `$adjacent`, refers to the type
      * of adjacency, 'next' or 'previous'.
+     *
+     * Possible hook names include:
+     *
+     *  - `next_post_link`
+     *  - `previous_post_link`
      *
      * @since 2.6.0