Changeset 47122 for trunk/src/wp-includes/class-wp-customize-manager.php

Timestamp:

01/29/2020 12:43:23 AM (6 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve inline comments per the documentation standards.

Includes minor code layout fixes for better readability.

See #48303.

File:

• trunk/src/wp-includes/class-wp-customize-manager.php (modified) (9 diffs)

trunk/src/wp-includes/class-wp-customize-manager.php

@@ -271 +271 @@
         }
 
-        // The theme and messenger_channel should be supplied via $args, but they are also looked at in the $_REQUEST global here for back-compat.
+        // The theme and messenger_channel should be supplied via $args,
+        // but they are also looked at in the $_REQUEST global here for back-compat.
         if ( ! isset( $args['theme'] ) ) {
             if ( isset( $_REQUEST['customize_theme'] ) ) {
@@ -384 +385 @@
 
         add_action( 'customize_register', array( $this, 'register_controls' ) );
-        add_action( 'customize_register', array( $this, 'register_dynamic_settings' ), 11 ); // allow code to create settings first
+        add_action( 'customize_register', array( $this, 'register_dynamic_settings' ), 11 ); // Allow code to create settings first.
         add_action( 'customize_controls_init', array( $this, 'prepare_controls' ) );
         add_action( 'customize_controls_enqueue_scripts', array( $this, 'enqueue_control_scripts' ) );
@@ -505 +506 @@
         global $pagenow;
 
-        // Check permissions for customize.php access since this method is called before customize.php can run any code,
+        // Check permissions for customize.php access since this method is called before customize.php can run any code.
         if ( 'customize.php' === $pagenow && ! current_user_can( 'customize' ) ) {
             if ( ! is_user_logged_in() ) {
@@ -564 +565 @@
             add_action( 'after_setup_theme', array( $this, 'after_setup_theme' ) );
         } else {
-            // If the requested theme is not the active theme and the user doesn't have the
-            // switch_themes cap, bail.
+            // If the requested theme is not the active theme and the user doesn't have
+            // the switch_themes cap, bail.
             if ( ! current_user_can( 'switch_themes' ) ) {
                 $this->wp_die( -1, __( 'Sorry, you are not allowed to edit theme options on this site.' ) );
@@ -899 +900 @@
     public function wp_loaded() {
 
-        // Unconditionally register core types for panels, sections, and controls in case plugin unhooks all customize_register actions.
+        // Unconditionally register core types for panels, sections, and controls
+        // in case plugin unhooks all customize_register actions.
         $this->register_panel_type( 'WP_Customize_Panel' );
         $this->register_panel_type( 'WP_Customize_Themes_Panel' );
@@ -2942 +2944 @@
                 // See _wp_translate_postdata() for why this is required as it will use the edit_post meta capability.
                 add_filter( 'map_meta_cap', array( $this, 'grant_edit_post_capability_for_changeset' ), 10, 4 );
+
                 $post_array['post_ID']   = $post_array['ID'];
                 $post_array['post_type'] = 'customize_changeset';
-                $r                       = wp_create_post_autosave( wp_slash( $post_array ) );
+
+                $r = wp_create_post_autosave( wp_slash( $post_array ) );
+
                 remove_filter( 'map_meta_cap', array( $this, 'grant_edit_post_capability_for_changeset' ), 10 );
             } else {
                 $post_array['edit_date'] = true; // Prevent date clearing.
-                $r                       = wp_update_post( wp_slash( $post_array ), true );
+
+                $r = wp_update_post( wp_slash( $post_array ), true );
 
                 // Delete autosave revision for user when the changeset is updated.
@@ -3733 +3739 @@
         $new_settings = array();
         foreach ( $setting_ids as $setting_id ) {
-            // Skip settings already created
+            // Skip settings already created.
             if ( $this->get_setting( $setting_id ) ) {
                 continue;
@@ -5203 +5209 @@
         );
 
-        // Input type: checkbox
-        // With custom value
+        // Input type: checkbox.
+        // With custom value.
         $this->add_control(
             'display_header_text',
@@ -5227 +5233 @@
         );
 
-        // Input type: Color
-        // With sanitize_callback
+        // Input type: color.
+        // With sanitize_callback.
         $this->add_setting(
             'background_color',