<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[54842] trunk/src/wp-includes/link-template.php: Docs: Minor DocBlock edits for `get_adjacent_post()` and related functions.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/54842">54842</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/54842","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>SergeyBiryukov</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2022-11-15 00:32:04 +0000 (Tue, 15 Nov 2022)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Docs: Minor DocBlock edits for `get_adjacent_post()` and related functions.
This aims to better match the line wrapping recommendations of the documentation standards.
Follow-up to <a href="https://core.trac.wordpress.org/changeset/16951">[16951]</a>, <a href="https://core.trac.wordpress.org/changeset/28111">[28111]</a>, <a href="https://core.trac.wordpress.org/changeset/32606">[32606]</a>, <a href="https://core.trac.wordpress.org/changeset/37254">[37254]</a>.
See <a href="https://core.trac.wordpress.org/ticket/56792">#56792</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludeslinktemplatephp">trunk/src/wp-includes/link-template.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludeslinktemplatephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/link-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/link-template.php 2022-11-15 00:17:03 UTC (rev 54841)
+++ trunk/src/wp-includes/link-template.php 2022-11-15 00:32:04 UTC (rev 54842)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1752,11 +1752,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param bool $in_same_term Optional. Whether post should be in a same taxonomy term. Default false.
- * @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. Default empty.
- * @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'.
- * @return WP_Post|null|string Post object if successful. Null if global $post is not set. Empty string if no
- * corresponding post exists.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param bool $in_same_term Optional. Whether post should be in the same taxonomy term.
+ * Default false.
+ * @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs.
+ * Default empty.
+ * @param string $taxonomy Optional. Taxonomy, if `$in_same_term` is true. Default 'category'.
+ * @return WP_Post|null|string Post object if successful. Null if global `$post` is not set.
+ * Empty string if no corresponding post exists.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_previous_post( $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return get_adjacent_post( $in_same_term, $excluded_terms, true, $taxonomy );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1767,11 +1769,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param bool $in_same_term Optional. Whether post should be in a same taxonomy term. Default false.
- * @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. Default empty.
- * @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'.
- * @return WP_Post|null|string Post object if successful. Null if global $post is not set. Empty string if no
- * corresponding post exists.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param bool $in_same_term Optional. Whether post should be in the same taxonomy term.
+ * Default false.
+ * @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs.
+ * Default empty.
+ * @param string $taxonomy Optional. Taxonomy, if `$in_same_term` is true. Default 'category'.
+ * @return WP_Post|null|string Post object if successful. Null if global `$post` is not set.
+ * Empty string if no corresponding post exists.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_next_post( $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return get_adjacent_post( $in_same_term, $excluded_terms, false, $taxonomy );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1786,12 +1790,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @global wpdb $wpdb WordPress database abstraction object.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param bool $in_same_term Optional. Whether post should be in a same taxonomy term. Default false.
- * @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. Default empty string.
- * @param bool $previous Optional. Whether to retrieve previous post. Default true
- * @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'.
- * @return WP_Post|null|string Post object if successful. Null if global $post is not set. Empty string if no
- * corresponding post exists.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param bool $in_same_term Optional. Whether post should be in the same taxonomy term.
+ * Default false.
+ * @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs.
+ * Default empty string.
+ * @param bool $previous Optional. Whether to retrieve previous post.
+ * Default true.
+ * @param string $taxonomy Optional. Taxonomy, if `$in_same_term` is true. Default 'category'.
+ * @return WP_Post|null|string Post object if successful. Null if global `$post` is not set.
+ * Empty string if no corresponding post exists.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_adjacent_post( $in_same_term = false, $excluded_terms = '', $previous = true, $taxonomy = 'category' ) {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wpdb;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1919,7 +1926,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.4.0 Added the `$taxonomy` and `$post` parameters.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $join The JOIN clause in the SQL.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param bool $in_same_term Whether post should be in a same taxonomy term.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param bool $in_same_term Whether post should be in the same taxonomy term.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param int[]|string $excluded_terms Array of excluded term IDs. Empty string if none were provided.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $taxonomy Taxonomy. Used to identify the term used when `$in_same_term` is true.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param WP_Post $post WP_Post object.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1941,7 +1948,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.4.0 Added the `$taxonomy` and `$post` parameters.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $where The `WHERE` clause in the SQL.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param bool $in_same_term Whether post should be in a same taxonomy term.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param bool $in_same_term Whether post should be in the same taxonomy term.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param int[]|string $excluded_terms Array of excluded term IDs. Empty string if none were provided.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $taxonomy Taxonomy. Used to identify the term used when `$in_same_term` is true.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param WP_Post $post WP_Post object.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2001,10 +2008,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.8.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $title Optional. Link title format. Default '%title'.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param bool $in_same_term Optional. Whether link should be in a same taxonomy term. Default false.
- * @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. Default empty.
- * @param bool $previous Optional. Whether to display link to previous or next post. Default true.
- * @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param bool $in_same_term Optional. Whether link should be in the same taxonomy term.
+ * Default false.
+ * @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs.
+ * Default empty.
+ * @param bool $previous Optional. Whether to display link to previous or next post.
+ * Default true.
+ * @param string $taxonomy Optional. Taxonomy, if `$in_same_term` is true. Default 'category'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string|void The adjacent post relational link URL.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_adjacent_post_rel_link( $title = '%title', $in_same_term = false, $excluded_terms = '', $previous = true, $taxonomy = 'category' ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2065,9 +2075,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.8.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $title Optional. Link title format. Default '%title'.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param bool $in_same_term Optional. Whether link should be in a same taxonomy term. Default false.
- * @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. Default empty.
- * @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param bool $in_same_term Optional. Whether link should be in the same taxonomy term.
+ * Default false.
+ * @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs.
+ * Default empty.
+ * @param string $taxonomy Optional. Taxonomy, if `$in_same_term` is true. Default 'category'.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function adjacent_posts_rel_link( $title = '%title', $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) {
</span><span class="cx" style="display: block; padding: 0 10px"> echo get_adjacent_post_rel_link( $title, $in_same_term, $excluded_terms, true, $taxonomy );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2100,9 +2112,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @see get_adjacent_post_rel_link()
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $title Optional. Link title format. Default '%title'.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param bool $in_same_term Optional. Whether link should be in a same taxonomy term. Default false.
- * @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. Default empty.
- * @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param bool $in_same_term Optional. Whether link should be in the same taxonomy term.
+ * Default false.
+ * @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs.
+ * Default empty.
+ * @param string $taxonomy Optional. Taxonomy, if `$in_same_term` is true. Default 'category'.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function next_post_rel_link( $title = '%title', $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) {
</span><span class="cx" style="display: block; padding: 0 10px"> echo get_adjacent_post_rel_link( $title, $in_same_term, $excluded_terms, false, $taxonomy );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2116,9 +2130,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @see get_adjacent_post_rel_link()
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $title Optional. Link title format. Default '%title'.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param bool $in_same_term Optional. Whether link should be in a same taxonomy term. Default false.
- * @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. Default true.
- * @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param bool $in_same_term Optional. Whether link should be in the same taxonomy term.
+ * Default false.
+ * @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs.
+ * Default true.
+ * @param string $taxonomy Optional. Taxonomy, if `$in_same_term` is true. Default 'category'.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function prev_post_rel_link( $title = '%title', $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) {
</span><span class="cx" style="display: block; padding: 0 10px"> echo get_adjacent_post_rel_link( $title, $in_same_term, $excluded_terms, true, $taxonomy );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2128,17 +2144,18 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Retrieves the boundary post.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Boundary being either the first or last post by publish date within the constraints specified
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * by $in_same_term or $excluded_terms.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * by `$in_same_term` or `$excluded_terms`.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.8.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param bool $in_same_term Optional. Whether returned post should be in a same taxonomy term.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param bool $in_same_term Optional. Whether returned post should be in the same taxonomy term.
</ins><span class="cx" style="display: block; padding: 0 10px"> * Default false.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs.
</span><span class="cx" style="display: block; padding: 0 10px"> * Default empty.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param bool $start Optional. Whether to retrieve first or last post. Default true
- * @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'.
- * @return null|array Array containing the boundary post object if successful, null otherwise.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param bool $start Optional. Whether to retrieve first or last post.
+ * Default true.
+ * @param string $taxonomy Optional. Taxonomy, if `$in_same_term` is true. Default 'category'.
+ * @return array|null Array containing the boundary post object if successful, null otherwise.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_boundary_post( $in_same_term = false, $excluded_terms = '', $start = true, $taxonomy = 'category' ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $post = get_post();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2198,9 +2215,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $format Optional. Link anchor format. Default '« %link'.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $link Optional. Link permalink format. Default '%title'.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param bool $in_same_term Optional. Whether link should be in a same taxonomy term. Default false.
- * @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. Default empty.
- * @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param bool $in_same_term Optional. Whether link should be in the same taxonomy term.
+ * Default false.
+ * @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs.
+ * Default empty.
+ * @param string $taxonomy Optional. Taxonomy, if `$in_same_term` is true. Default 'category'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string The link URL of the previous post in relation to the current post.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_previous_post_link( $format = '« %link', $link = '%title', $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2216,9 +2235,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $format Optional. Link anchor format. Default '« %link'.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $link Optional. Link permalink format. Default '%title'.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param bool $in_same_term Optional. Whether link should be in a same taxonomy term. Default false.
- * @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. Default empty.
- * @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param bool $in_same_term Optional. Whether link should be in the same taxonomy term.
+ * Default false.
+ * @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs.
+ * Default empty.
+ * @param string $taxonomy Optional. Taxonomy, if `$in_same_term` is true. Default 'category'.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function previous_post_link( $format = '« %link', $link = '%title', $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) {
</span><span class="cx" style="display: block; padding: 0 10px"> echo get_previous_post_link( $format, $link, $in_same_term, $excluded_terms, $taxonomy );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2231,9 +2252,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $format Optional. Link anchor format. Default '« %link'.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $link Optional. Link permalink format. Default '%title'.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param bool $in_same_term Optional. Whether link should be in a same taxonomy term. Default false.
- * @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. Default empty.
- * @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param bool $in_same_term Optional. Whether link should be in the same taxonomy term.
+ * Default false.
+ * @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs.
+ * Default empty.
+ * @param string $taxonomy Optional. Taxonomy, if `$in_same_term` is true. Default 'category'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string The link URL of the next post in relation to the current post.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_next_post_link( $format = '%link »', $link = '%title', $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2248,10 +2271,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @see get_next_post_link()
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $format Optional. Link anchor format. Default '« %link'.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $link Optional. Link permalink format. Default '%title'
- * @param bool $in_same_term Optional. Whether link should be in a same taxonomy term. Default false.
- * @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. Default empty.
- * @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $link Optional. Link permalink format. Default '%title'.
+ * @param bool $in_same_term Optional. Whether link should be in the same taxonomy term.
+ * Default false.
+ * @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs.
+ * Default empty.
+ * @param string $taxonomy Optional. Taxonomy, if `$in_same_term` is true. Default 'category'.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function next_post_link( $format = '%link »', $link = '%title', $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) {
</span><span class="cx" style="display: block; padding: 0 10px"> echo get_next_post_link( $format, $link, $in_same_term, $excluded_terms, $taxonomy );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2266,10 +2291,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $format Link anchor format.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $link Link permalink format.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param bool $in_same_term Optional. Whether link should be in a same taxonomy term. Default false.
- * @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded terms IDs. Default empty.
- * @param bool $previous Optional. Whether to display link to previous or next post. Default true.
- * @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param bool $in_same_term Optional. Whether link should be in the same taxonomy term.
+ * Default false.
+ * @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded terms IDs.
+ * Default empty.
+ * @param bool $previous Optional. Whether to display link to previous or next post.
+ * Default true.
+ * @param string $taxonomy Optional. Taxonomy, if `$in_same_term` is true. Default 'category'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string The link URL of the previous or next post in relation to the current post.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_adjacent_post_link( $format, $link, $in_same_term = false, $excluded_terms = '', $previous = true, $taxonomy = 'category' ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2336,10 +2364,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $format Link anchor format.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $link Link permalink format.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param bool $in_same_term Optional. Whether link should be in a same taxonomy term. Default false.
- * @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded category IDs. Default empty.
- * @param bool $previous Optional. Whether to display link to previous or next post. Default true.
- * @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param bool $in_same_term Optional. Whether link should be in the same taxonomy term.
+ * Default false.
+ * @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded category IDs.
+ * Default empty.
+ * @param bool $previous Optional. Whether to display link to previous or next post.
+ * Default true.
+ * @param string $taxonomy Optional. Taxonomy, if `$in_same_term` is true. Default 'category'.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function adjacent_post_link( $format, $link, $in_same_term = false, $excluded_terms = '', $previous = true, $taxonomy = 'category' ) {
</span><span class="cx" style="display: block; padding: 0 10px"> echo get_adjacent_post_link( $format, $link, $in_same_term, $excluded_terms, $previous, $taxonomy );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2353,8 +2384,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $pagenum Optional. Page number. Default 1.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param bool $escape Optional. Whether to escape the URL for display, with esc_url(). Defaults to true.
- * Otherwise, prepares the URL with sanitize_url().
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param bool $escape Optional. Whether to escape the URL for display, with esc_url().
+ * If set to false, prepares the URL with sanitize_url(). Default true.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string The link URL for the given page number.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_pagenum_link( $pagenum = 1, $escape = true ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2683,12 +2714,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $args {
</span><span class="cx" style="display: block; padding: 0 10px"> * Optional. Default post navigation arguments. Default empty array.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type string $prev_text Anchor text to display in the previous post link. Default '%title'.
- * @type string $next_text Anchor text to display in the next post link. Default '%title'.
- * @type bool $in_same_term Whether link should be in a same taxonomy term. Default false.
- * @type int[]|string $excluded_terms Array or comma-separated list of excluded term IDs. Default empty.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type string $prev_text Anchor text to display in the previous post link.
+ * Default '%title'.
+ * @type string $next_text Anchor text to display in the next post link.
+ * Default '%title'.
+ * @type bool $in_same_term Whether link should be in the same taxonomy term.
+ * Default false.
+ * @type int[]|string $excluded_terms Array or comma-separated list of excluded term IDs.
+ * Default empty.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @type string $taxonomy Taxonomy, if `$in_same_term` is true. Default 'category'.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type string $screen_reader_text Screen reader text for the nav element. Default 'Post navigation'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type string $screen_reader_text Screen reader text for the nav element.
+ * Default 'Post navigation'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @type string $aria_label ARIA label text for the nav element. Default 'Posts'.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $class Custom class for the nav element. Default 'post-navigation'.
</span><span class="cx" style="display: block; padding: 0 10px"> * }
</span></span></pre>
</div>
</div>
</body>
</html>