<!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>[55868] trunk: Docs: Add a `@since` tag for the `pre_wp_setup_nav_menu_item` filter.</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/55868">55868</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/55868","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>2023-05-30 14:11:46 +0000 (Tue, 30 May 2023)</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: Add a `@since` tag for the `pre_wp_setup_nav_menu_item` filter.
Includes moving the unit test next to the other `wp_setup_nav_menu_item()` tests and using the `MockAction` class to confirm that the filter runs.
Follow-up to <a href="https://core.trac.wordpress.org/changeset/55867">[55867]</a>.
Props TobiasBg.
Fixes <a href="https://core.trac.wordpress.org/ticket/56577">#56577</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesnavmenuphp">trunk/src/wp-includes/nav-menu.php</a></li>
<li><a href="#trunktestsphpunittestspostnavmenuphp">trunk/tests/phpunit/tests/post/nav-menu.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesnavmenuphp"></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/nav-menu.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/nav-menu.php 2023-05-30 11:19:41 UTC (rev 55867)
+++ trunk/src/wp-includes/nav-menu.php 2023-05-30 14:11:46 UTC (rev 55868)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -822,11 +822,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_setup_nav_menu_item( $menu_item ) {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Short-circuit the wp_setup_nav_menu_item() output.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Filters whether to short-circuit the wp_setup_nav_menu_item() output.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Returning a non-null value from the filter will short-circuit wp_setup_nav_menu_item(),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * and return that value.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * returning that value instead.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 6.3.0
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param object|null $modified_menu_item Modified menu item. Default null.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param object $menu_item The menu item to modify.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span></span></pre></div>
<a id="trunktestsphpunittestspostnavmenuphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/post/nav-menu.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/post/nav-menu.php 2023-05-30 11:19:41 UTC (rev 55867)
+++ trunk/tests/phpunit/tests/post/nav-menu.php 2023-05-30 14:11:46 UTC (rev 55868)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -592,6 +592,31 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @ticket 56577
+ */
+ public function test_wp_setup_nav_menu_item_short_circuit_filter() {
+ $post_id = self::factory()->post->create();
+
+ $menu_item_id = wp_update_nav_menu_item(
+ $this->menu_id,
+ 0,
+ array(
+ 'menu-item-type' => 'post_type',
+ 'menu-item-object' => 'post',
+ 'menu-item-object-id' => $post_id,
+ 'menu-item-status' => 'publish',
+ )
+ );
+
+ $filter = new MockAction();
+ add_filter( 'pre_wp_setup_nav_menu_item', array( &$filter, 'filter' ) );
+
+ wp_setup_nav_menu_item( get_post( $menu_item_id ) );
+
+ $this->assertSame( 1, $filter->get_call_count() );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * @ticket 35206
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_wp_nav_menu_whitespace_options() {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1344,32 +1369,4 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $post = get_post( $menu_item_id );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEqualsWithDelta( strtotime( gmdate( 'Y-m-d H:i:s' ) ), strtotime( $post->post_date ), 2, 'The dates should be equal' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
- /**
- * @ticket 56577
- */
- public function test_nav_menu_item_short_circuit_filter() {
- // Create a nav menu item.
- $menu_item_args = array(
- 'menu-item-type' => 'custom',
- 'menu-item-title' => 'Wordpress.org',
- 'menu-item-url' => 'http://wordpress.org',
- 'menu-item-status' => 'publish',
- );
-
- $custom_item_id = wp_update_nav_menu_item( 0, 0, $menu_item_args );
-
- $pre_setup_callback = function() {
- return '--empty nav menu item--';
- };
-
- add_filter( 'pre_wp_setup_nav_menu_item', $pre_setup_callback );
-
- // Confirm the short-circuit.
- $custom_item = wp_setup_nav_menu_item( get_post( $custom_item_id ) );
- $this->assertSame( '--empty nav menu item--', $custom_item );
-
- remove_filter( 'pre_wp_setup_nav_menu_item', $pre_setup_callback );
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>