<!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>[37748] trunk: Menus: Support nested array variables in POST data when saving menus.</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 { 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/37748">37748</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/37748","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>swissspidy</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-06-19 12:24:23 +0000 (Sun, 19 Jun 2016)</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'>Menus: Support nested array variables in POST data when saving menus.
<a href="https://core.trac.wordpress.org/changeset/36510">[36510]</a> allowed larger menus to be created in the Edit Menu screen by JSON-encoding the entire form into a single input field. However, it did not correctly handle nested arrays.
This introduces a new `_wp_expand_nav_menu_post_data()` helper function to handle this POST data which uses `array_replace_recursive()` internally. Since the latter is only available on PHP 5.3+, we add a compatibility function to ensure PHP 5.2 support.
Props ericlewis, neverything, swissspidy.
Fixes <a href="https://core.trac.wordpress.org/ticket/36590">#36590</a> for trunk. See <a href="https://core.trac.wordpress.org/ticket/14134">#14134</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesnavmenuphp">trunk/src/wp-admin/includes/nav-menu.php</a></li>
<li><a href="#trunksrcwpadminnavmenusphp">trunk/src/wp-admin/nav-menus.php</a></li>
<li><a href="#trunksrcwpincludescompatphp">trunk/src/wp-includes/compat.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li>trunk/tests/phpunit/tests/menu/</li>
<li><a href="#trunktestsphpunittestsmenuwpExpandNavMenuPostDataphp">trunk/tests/phpunit/tests/menu/wpExpandNavMenuPostData.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesnavmenuphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/nav-menu.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/nav-menu.php 2016-06-19 12:01:11 UTC (rev 37747)
+++ trunk/src/wp-admin/includes/nav-menu.php 2016-06-19 12:24:23 UTC (rev 37748)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1059,3 +1059,46 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return $messages;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+/**
+ * If a JSON blob of navigation menu data is in POST data, expand it and inject
+ * it into `$_POST` to avoid PHP `max_input_vars` limitations. See #14134.
+ *
+ * @ignore
+ * @since 4.5.3
+ * @access private
+ */
+function _wp_expand_nav_menu_post_data() {
+ if ( ! isset( $_POST['nav-menu-data'] ) ) {
+ return;
+ }
+
+ $data = json_decode( stripslashes( $_POST['nav-menu-data'] ) );
+
+ if ( ! is_null( $data ) && $data ) {
+ foreach ( $data as $post_input_data ) {
+ // For input names that are arrays (e.g. `menu-item-db-id[3][4][5]`),
+ // derive the array path keys via regex and set the value in $_POST.
+ preg_match( '#([^\[]*)(\[(.+)\])?#', $post_input_data->name, $matches );
+
+ $array_bits = array( $matches[1] );
+
+ if ( isset( $matches[3] ) ) {
+ $array_bits = array_merge( $array_bits, explode( '][', $matches[3] ) );
+ }
+
+ $new_post_data = array();
+
+ // Build the new array value from leaf to trunk.
+ for ( $i = count( $array_bits ) - 1; $i >= 0; $i -- ) {
+ if ( $i == count( $array_bits ) - 1 ) {
+ $new_post_data[ $array_bits[ $i ] ] = wp_slash( $post_input_data->value );
+ } else {
+ $new_post_data = array( $array_bits[ $i ] => $new_post_data );
+ }
+ }
+
+ $_POST = array_replace_recursive( $_POST, $new_post_data );
+ }
+ }
+}
</ins></span></pre></div>
<a id="trunksrcwpadminnavmenusphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/nav-menus.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/nav-menus.php 2016-06-19 12:01:11 UTC (rev 37747)
+++ trunk/src/wp-admin/nav-menus.php 2016-06-19 12:24:23 UTC (rev 37748)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -53,26 +53,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * If a JSON blob of navigation menu data is found, expand it and inject it
</span><span class="cx" style="display: block; padding: 0 10px"> * into `$_POST` to avoid PHP `max_input_vars` limitations. See #14134.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-if ( isset( $_POST['nav-menu-data'] ) ) {
- $data = json_decode( stripslashes( $_POST['nav-menu-data'] ) );
- if ( ! is_null( $data ) && $data ) {
- foreach ( $data as $post_input_data ) {
- // For input names that are arrays (e.g. `menu-item-db-id[3]`), derive the array path keys via regex.
- if ( preg_match( '#(.*)\[(\w+)\]#', $post_input_data->name, $matches ) ) {
- if ( empty( $_POST[ $matches[1] ] ) ) {
- $_POST[ $matches[1] ] = array();
- }
- // Cast input elements with a numeric array index to integers.
- if ( is_numeric( $matches[2] ) ) {
- $matches[2] = (int) $matches[2];
- }
- $_POST[ $matches[1] ][ $matches[2] ] = wp_slash( $post_input_data->value );
- } else {
- $_POST[ $post_input_data->name ] = wp_slash( $post_input_data->value );
- }
- }
- }
-}
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+_wp_expand_nav_menu_post_data();
+
</ins><span class="cx" style="display: block; padding: 0 10px"> switch ( $action ) {
</span><span class="cx" style="display: block; padding: 0 10px"> case 'add-menu-item':
</span><span class="cx" style="display: block; padding: 0 10px"> check_admin_referer( 'add-menu_item', 'menu-settings-column-nonce' );
</span></span></pre></div>
<a id="trunksrcwpincludescompatphp"></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/compat.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/compat.php 2016-06-19 12:01:11 UTC (rev 37747)
+++ trunk/src/wp-includes/compat.php 2016-06-19 12:24:23 UTC (rev 37748)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -435,6 +435,56 @@
</span><span class="cx" style="display: block; padding: 0 10px"> require ABSPATH . WPINC . '/random_compat/random.php';
</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">+if ( ! function_exists( 'array_replace_recursive' ) ) :
+ /**
+ * PHP-agnostic version of {@link array_replace_recursive()}.
+ *
+ * The array_replace_recursive() function is a PHP 5.3 function. WordPress
+ * currently supports down to PHP 5.2, so this method is a workaround
+ * for PHP 5.2.
+ *
+ * Note: array_replace_recursive() supports infinite arguments, but for our use-
+ * case, we only need to support two arguments.
+ *
+ * Subject to removal once WordPress makes PHP 5.3.0 the minimum requirement.
+ *
+ * @since 4.5.3
+ *
+ * @see http://php.net/manual/en/function.array-replace-recursive.php#109390
+ *
+ * @param array $base Array with keys needing to be replaced.
+ * @param array $replacements Array with the replaced keys.
+ *
+ * @return array
+ */
+ function array_replace_recursive( $base = array(), $replacements = array() ) {
+ foreach ( array_slice( func_get_args(), 1 ) as $replacements ) {
+ $bref_stack = array( &$base );
+ $head_stack = array( $replacements );
+
+ do {
+ end( $bref_stack );
+
+ $bref = &$bref_stack[ key( $bref_stack ) ];
+ $head = array_pop( $head_stack );
+
+ unset( $bref_stack[ key( $bref_stack ) ] );
+
+ foreach ( array_keys( $head ) as $key ) {
+ if ( isset( $key, $bref ) && is_array( $bref[ $key ] ) && is_array( $head[ $key ] ) ) {
+ $bref_stack[] = &$bref[ $key ];
+ $head_stack[] = $head[ $key ];
+ } else {
+ $bref[ $key ] = $head[ $key ];
+ }
+ }
+ } while ( count( $head_stack ) );
+ }
+
+ return $base;
+ }
+endif;
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // SPL can be disabled on PHP 5.2
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! function_exists( 'spl_autoload_register' ) ):
</span><span class="cx" style="display: block; padding: 0 10px"> $_wp_spl_autoloaders = array();
</span></span></pre></div>
<a id="trunktestsphpunittestsmenuwpExpandNavMenuPostDataphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/tests/menu/wpExpandNavMenuPostData.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/menu/wpExpandNavMenuPostData.php (rev 0)
+++ trunk/tests/phpunit/tests/menu/wpExpandNavMenuPostData.php 2016-06-19 12:24:23 UTC (rev 37748)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,105 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+/**
+ * @group menu
+ * @ticket 36590
+ */
+class Tests_Menu_WpExpandNavMenuPostData extends WP_UnitTestCase {
+ public function test_unnested_data_should_expand() {
+ include_once( ABSPATH . 'wp-admin/includes/nav-menu.php' );
+
+ if ( empty( $_POST ) ) {
+ $_POST = array();
+ }
+
+ $data = array();
+ $data[0] = new StdClass;
+ $data[0]->name = 'yesorno';
+ $data[0]->value = 'yes';
+ $_POST['nav-menu-data'] = addslashes( json_encode( $data ) );
+
+ _wp_expand_nav_menu_post_data();
+
+ $expected = array(
+ 'nav-menu-data' => $_POST['nav-menu-data'],
+ 'yesorno' => 'yes'
+ );
+
+ $this->assertEquals( $expected, $_POST );
+ }
+
+ public function test_multidimensional_nested_array_should_expand() {
+ include_once( ABSPATH . 'wp-admin/includes/nav-menu.php' );
+
+ if ( empty( $_POST ) ) {
+ $_POST = array();
+ }
+
+ $data = array();
+ $data[0] = new StdClass;
+ $data[0]->name = 'would[1][do][the][trick]';
+ $data[0]->value = 'yes';
+ $_POST['nav-menu-data'] = addslashes( json_encode( $data ) );
+
+ _wp_expand_nav_menu_post_data();
+
+ $expected = array(
+ 'nav-menu-data' => $_POST['nav-menu-data'],
+ 'would' => array(
+ 1 => array(
+ 'do' => array(
+ 'the' => array(
+ 'trick' => 'yes',
+ ),
+ ),
+ ),
+ ),
+ );
+ $this->assertEquals( $expected, $_POST );
+ }
+
+ public function test_multidimensional_nested_array_should_expand_and_merge() {
+ include_once( ABSPATH . 'wp-admin/includes/nav-menu.php' );
+
+ if ( empty( $_POST ) ) {
+ $_POST = array();
+ }
+
+ $data = array();
+ $data[0] = new StdClass;
+ $data[0]->name = 'would[1][do][the][trick]';
+ $data[0]->value = 'yes';
+ $data[1] = new StdClass;
+ $data[1]->name = 'would[2][do][the][trick]';
+ $data[1]->value = 'yes';
+ $data[2] = new StdClass;
+ $data[2]->name = 'would[2][do][the][job]';
+ $data[2]->value = 'yes';
+ $_POST['nav-menu-data'] = addslashes( json_encode( $data ) );
+
+ _wp_expand_nav_menu_post_data();
+
+ $expected = array(
+ 'nav-menu-data' => $_POST['nav-menu-data'],
+ 'would' => array(
+ 1 => array(
+ 'do' => array(
+ 'the' => array(
+ 'trick' => 'yes',
+ ),
+ ),
+ ),
+ 2 => array(
+ 'do' => array(
+ 'the' => array(
+ 'trick' => 'yes',
+ 'job' => 'yes',
+ ),
+ ),
+ ),
+ ),
+ );
+
+ $this->assertEquals( $expected, $_POST );
+ }
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/tests/phpunit/tests/menu/wpExpandNavMenuPostData.php
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span></div>
</body>
</html>