Changeset 47122 for trunk/src/wp-includes/rest-api/fields/class-wp-rest-meta-fields.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/rest-api/fields/class-wp-rest-meta-fields.php (modified) (8 diffs)

trunk/src/wp-includes/rest-api/fields/class-wp-rest-meta-fields.php

@@ -80 +80 @@
                         $name       = $args['name'];
                         $all_values = get_metadata( $this->get_meta_type(), $object_id, $meta_key, false );
+
                         if ( $args['single'] ) {
                                 if ( empty( $all_values ) ) {
@@ -86 +87 @@
                                         $value = $all_values[0];
                                 }
+
                                 $value = $this->prepare_value_for_response( $value, $request, $args );
                         } else {
                                 $value = array();
+
                                 foreach ( $all_values as $row ) {
                                         $value[] = $this->prepare_value_for_response( $row, $request, $args );
@@ -133 +136 @@
         public function update_value( $meta, $object_id ) {
                 $fields = $this->get_registered_fields();
+
                 foreach ( $fields as $meta_key => $args ) {
                         $name = $args['name'];
@@ -211 +215 @@
         protected function delete_meta_value( $object_id, $meta_key, $name ) {
                 $meta_type = $this->get_meta_type();
+
                 if ( ! current_user_can( "delete_{$meta_type}_meta", $object_id, $meta_key ) ) {
                         return new WP_Error(
@@ -252 +257 @@
         protected function update_multi_meta_value( $object_id, $meta_key, $name, $values ) {
                 $meta_type = $this->get_meta_type();
+
                 if ( ! current_user_can( "edit_{$meta_type}_meta", $object_id, $meta_key ) ) {
                         return new WP_Error(
@@ -287 +293 @@
                 }
 
-                // `delete_metadata` removes _all_ instances of the value, so only call once. Otherwise,
-                // `delete_metadata` will return false for subsequent calls of the same value.
-                // Use serialization to produce a predictable string that can be used by array_unique.
+                /*
+                 * `delete_metadata` removes _all_ instances of the value, so only call once. Otherwise,
+                 * `delete_metadata` will return false for subsequent calls of the same value.
+                 * Use serialization to produce a predictable string that can be used by array_unique.
+                 */
                 $to_remove = array_map( 'maybe_unserialize', array_unique( array_map( 'maybe_serialize', $to_remove ) ) );
 
@@ -336 +344 @@
         protected function update_meta_value( $object_id, $meta_key, $name, $value ) {
                 $meta_type = $this->get_meta_type();
+
                 if ( ! current_user_can( "edit_{$meta_type}_meta", $object_id, $meta_key ) ) {
                         return new WP_Error(
@@ -495 +504 @@
          */
         public static function prepare_value( $value, $request, $args ) {
-
                 if ( $args['single'] ) {
                         $schema = $args['schema'];