Changeset 34269 for trunk/src/wp-admin/customize.php

Timestamp:

09/17/2015 07:41:35 PM (9 years ago)

Author:

westonruter

Message:

Customize: Reduce peak memory usage by JSON-encoding settings and controls individually.

When there are hundreds of settings and controls (e.g. nav menu items and widget instances) the resulting object that is JSON-encoded can become very large, and wp_json_encode() can consume a lot of memory to serialize it. By breaking down the serialization into multiple calls the peak memory usage can be kept in line.

Moves logic out of wp-admin/customize.php into the WP_Customize_Manager class with new methods:

• is_ios()
• get_document_title_template()
• get_preview_url()/set_preview_url()
• get_return_url()/set_return_url()
• get_autofocus()/set_autofocus()
• customize_pane_settings()

Includes unit tests for these methods, for which the logic was formerly untestable in customize.php.

Fixes #33898.

File:

• trunk/src/wp-admin/customize.php (modified) (5 diffs)

trunk/src/wp-admin/customize.php

@@ -21 +21 @@
 }
 
-wp_reset_vars( array( 'url', 'return' ) );
-$url = wp_unslash( $url );
-$url = wp_validate_redirect( $url, home_url( '/' ) );
-if ( $return ) {
-    $return = wp_unslash( $return );
-    $return = remove_query_arg( wp_removable_query_args(), $return );
-    $return = wp_validate_redirect( $return );
+wp_reset_vars( array( 'url', 'return', 'autofocus' ) );
+if ( ! empty( $url ) ) {
+    $wp_customize->set_preview_url( wp_unslash( $url ) );
 }
-if ( ! $return ) {
-    if ( $url ) {
-        $return = $url;
-    } elseif ( current_user_can( 'edit_theme_options' ) || current_user_can( 'switch_themes' ) ) {
-        $return = admin_url( 'themes.php' );
-    } else {
-        $return = admin_url();
-    }
+if ( ! empty( $return ) ) {
+    $wp_customize->set_return_url( wp_unslash( $return ) );
+}
+if ( ! empty( $autofocus ) && is_array( $autofocus ) ) {
+    $wp_customize->set_autofocus( wp_unslash( $autofocus ) );
 }
 
@@ -84 +77 @@
 endif;
 
-$is_ios = wp_is_mobile() && preg_match( '/iPad|iPod|iPhone/', $_SERVER['HTTP_USER_AGENT'] );
-
-if ( $is_ios ) {
+if ( $wp_customize->is_ios() ) {
     $body_class .= ' ios';
 }
@@ -95 +86 @@
 $body_class .= ' locale-' . sanitize_html_class( strtolower( str_replace( '_', '-', get_locale() ) ) );
 
-if ( $wp_customize->is_theme_active() ) {
-    $document_title_tmpl = _x( 'Customize: %s', 'Placeholder is the document title from the preview' );
-} else {
-    $document_title_tmpl = _x( 'Live Preview: %s', 'Placeholder is the document title from the preview' );
-}
-$document_title_tmpl = html_entity_decode( $document_title_tmpl, ENT_QUOTES, 'UTF-8' ); // because exported to JS and assigned to document.title
-$admin_title = sprintf( $document_title_tmpl, __( 'Loading…' ) );
+$admin_title = sprintf( $wp_customize->get_document_title_template(), __( 'Loading…' ) );
 
 ?><title><?php echo $admin_title; ?></title>
 
 <script type="text/javascript">
-var ajaxurl = '<?php echo admin_url( 'admin-ajax.php', 'relative' ); ?>';
+var ajaxurl = <?php echo wp_json_encode( admin_url( 'admin-ajax.php', 'relative' ) ); ?>;
 </script>
 
@@ -138 +123 @@
                 <span class="preview"><?php _e( 'Preview' ); ?></span>
             </a>
-            <a class="customize-controls-close" href="<?php echo esc_url( $return ); ?>">
+            <a class="customize-controls-close" href="<?php echo esc_url( $wp_customize->get_return_url() ); ?>">
                 <span class="screen-reader-text"><?php _e( 'Cancel' ); ?></span>
             </a>
@@ -173 +158 @@
     <?php
 
-    // Render Panel, Section, and Control templates.
-    $wp_customize->render_panel_templates();
-    $wp_customize->render_section_templates();
-    $wp_customize->render_control_templates();
-
     /**
-     * Print Customizer control scripts in the footer.
+     * Print templates, control scripts, and settings in the footer.
      *
      * @since 3.4.0
      */
     do_action( 'customize_controls_print_footer_scripts' );
-
-    /*
-     * If the frontend and the admin are served from the same domain, load the
-     * preview over ssl if the Customizer is being loaded over ssl. This avoids
-     * insecure content warnings. This is not attempted if the admin and frontend
-     * are on different domains to avoid the case where the frontend doesn't have
-     * ssl certs. Domain mapping plugins can allow other urls in these conditions
-     * using the customize_allowed_urls filter.
-     */
-
-    $allowed_urls = array( home_url('/') );
-    $admin_origin = parse_url( admin_url() );
-    $home_origin  = parse_url( home_url() );
-    $cross_domain = ( strtolower( $admin_origin[ 'host' ] ) != strtolower( $home_origin[ 'host' ] ) );
-
-    if ( is_ssl() && ! $cross_domain )
-        $allowed_urls[] = home_url( '/', 'https' );
-
-    /**
-     * Filter the list of URLs allowed to be clicked and followed in the Customizer preview.
-     *
-     * @since 3.4.0
-     *
-     * @param array $allowed_urls An array of allowed URLs.
-     */
-    $allowed_urls = array_unique( apply_filters( 'customize_allowed_urls', $allowed_urls ) );
-
-    $login_url = add_query_arg( array(
-        'interim-login' => 1,
-        'customize-login' => 1
-    ), wp_login_url() );
-
-    // Prepare Customizer settings to pass to JavaScript.
-    $settings = array(
-        'theme'    => array(
-            'stylesheet' => $wp_customize->get_stylesheet(),
-            'active'     => $wp_customize->is_theme_active(),
-        ),
-        'url'      => array(
-            'preview'       => esc_url_raw( $url ? $url : home_url( '/' ) ),
-            'parent'        => esc_url_raw( admin_url() ),
-            'activated'     => esc_url_raw( home_url( '/' ) ),
-            'ajax'          => esc_url_raw( admin_url( 'admin-ajax.php', 'relative' ) ),
-            'allowed'       => array_map( 'esc_url_raw', $allowed_urls ),
-            'isCrossDomain' => $cross_domain,
-            'home'          => esc_url_raw( home_url( '/' ) ),
-            'login'         => esc_url_raw( $login_url ),
-        ),
-        'browser'  => array(
-            'mobile' => wp_is_mobile(),
-            'ios'    => $is_ios,
-        ),
-        'settings' => array(),
-        'controls' => array(),
-        'panels'   => array(),
-        'sections' => array(),
-        'nonce'    => array(
-            'save'    => wp_create_nonce( 'save-customize_' . $wp_customize->get_stylesheet() ),
-            'preview' => wp_create_nonce( 'preview-customize_' . $wp_customize->get_stylesheet() )
-        ),
-        'autofocus' => array(),
-        'documentTitleTmpl' => $document_title_tmpl,
-    );
-
-    // Prepare Customize Setting objects to pass to JavaScript.
-    foreach ( $wp_customize->settings() as $id => $setting ) {
-        if ( $setting->check_capabilities() ) {
-            $settings['settings'][ $id ] = array(
-                'value'     => $setting->js_value(),
-                'transport' => $setting->transport,
-                'dirty'     => $setting->dirty,
-            );
-        }
-    }
-
-    // Prepare Customize Control objects to pass to JavaScript.
-    foreach ( $wp_customize->controls() as $id => $control ) {
-        if ( $control->check_capabilities() ) {
-            $settings['controls'][ $id ] = $control->json();
-        }
-    }
-
-    // Prepare Customize Section objects to pass to JavaScript.
-    foreach ( $wp_customize->sections() as $id => $section ) {
-        if ( $section->check_capabilities() ) {
-            $settings['sections'][ $id ] = $section->json();
-        }
-    }
-
-    // Prepare Customize Panel objects to pass to JavaScript.
-    foreach ( $wp_customize->panels() as $panel_id => $panel ) {
-        if ( $panel->check_capabilities() ) {
-            $settings['panels'][ $panel_id ] = $panel->json();
-            foreach ( $panel->sections as $section_id => $section ) {
-                if ( $section->check_capabilities() ) {
-                    $settings['sections'][ $section_id ] = $section->json();
-                }
-            }
-        }
-    }
-
-    // Pass to frontend the Customizer construct being deeplinked
-    if ( isset( $_GET['autofocus'] ) ) {
-        $autofocus = wp_unslash( $_GET['autofocus'] );
-        if ( is_array( $autofocus ) ) {
-            foreach ( $autofocus as $type => $id ) {
-                if ( isset( $settings[ $type . 's' ][ $id ] ) ) {
-                    $settings['autofocus'][ $type ] = $id;
-                }
-            }
-        }
-    }
-
     ?>
-    <script type="text/javascript">
-        var _wpCustomizeSettings = <?php echo wp_json_encode( $settings ); ?>;
-    </script>
 </div>
 </body>