vhad/wordpress-develop
1
0
Fork 0
mirror of https://github.com/gosticks/wordpress-develop.git synced 2026-06-28 14:20:15 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

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

Browse Source 
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


git-svn-id: https://develop.svn.wordpress.org/trunk@50505 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
John Blackbourn
2021-03-07 12:30:38 +00:00
parent c3be472657
commit fa05e5e733
26 changed files with 403 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
src/wp-includes/link-template.php
View File

@@ -1811,6 +1811,11 @@ function get_adjacent_post( $in_same_term = false, $excluded_terms = '', $previo
* The dynamic portion of the hook name, `$adjacent`, refers to the type
* of adjacency, 'next' or 'previous'.
*
* Possible hook names include:
*
* - `get_next_post_excluded_terms`
* - `get_previous_post_excluded_terms`
*
* @since 4.4.0
*
* @param array|string $excluded_terms Array of excluded term IDs. Empty string if none were provided.
@@ -1882,6 +1887,11 @@ function get_adjacent_post( $in_same_term = false, $excluded_terms = '', $previo
* The dynamic portion of the hook name, `$adjacent`, refers to the type
* 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.
*
@@ -1899,6 +1909,11 @@ function get_adjacent_post( $in_same_term = false, $excluded_terms = '', $previo
* The dynamic portion of the hook name, `$adjacent`, refers to the type
* 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,6 +1931,11 @@ function get_adjacent_post( $in_same_term = false, $excluded_terms = '', $previo
* 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
* @since 4.4.0 Added the `$post` parameter.
* @since 4.9.0 Added the `$order` parameter.
@@ -2004,6 +2024,11 @@ function get_adjacent_post_rel_link( $title = '%title', $in_same_term = false, $
* 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
*
* @param string $link The relational link.
@@ -2261,6 +2286,11 @@ function get_adjacent_post_link( $format, $link, $in_same_term = false, $exclude
* 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
* @since 4.2.0 Added the `$adjacent` parameter.
*