Changeset 53801

Timestamp:

07/30/2022 03:14:34 PM (3 years ago)

Author:

SergeyBiryukov

Message:

Coding Standards: Use more meaningful variables names in some Ajax functions.

This renames $tax to $taxonomy_object and $s to $search for clarity. The latter is only renamed when used as an internal variable and not referring to the $s global.

The list of affected functions:

• wp_ajax_ajax_tag_search()
• wp_ajax_add_link_category
• wp_ajax_add_tag()
• wp_ajax_get_tagcloud()
• wp_ajax_inline_save_tax()
• wp_ajax_find_posts()

Follow-up to [6542], [8901], [10222], [12833], [16771], [16992], [22723], [38698].

Props azouamauriac.
Fixes #55098.

File:

• trunk/src/wp-admin/includes/ajax-actions.php (modified) (13 diffs)

trunk/src/wp-admin/includes/ajax-actions.php

@@ -109 +109 @@
     }
 
-    $taxonomy = sanitize_key( $_GET['tax'] );
-    $tax      = get_taxonomy( $taxonomy );
-
-    if ( ! $tax ) {
+    $taxonomy        = sanitize_key( $_GET['tax'] );
+    $taxonomy_object = get_taxonomy( $taxonomy );
+
+    if ( ! $taxonomy_object ) {
         wp_die( 0 );
     }
 
-    if ( ! current_user_can( $tax->cap->assign_terms ) ) {
+    if ( ! current_user_can( $taxonomy_object->cap->assign_terms ) ) {
         wp_die( -1 );
     }
 
-    $s = wp_unslash( $_GET['q'] );
+    $search = wp_unslash( $_GET['q'] );
 
     $comma = _x( ',', 'tag delimiter' );
     if ( ',' !== $comma ) {
-        $s = str_replace( $comma, ',', $s );
-    }
-
-    if ( false !== strpos( $s, ',' ) ) {
-        $s = explode( ',', $s );
-        $s = $s[ count( $s ) - 1 ];
-    }
-
-    $s = trim( $s );
+        $search = str_replace( $comma, ',', $search );
+    }
+
+    if ( false !== strpos( $search, ',' ) ) {
+        $search = explode( ',', $search );
+        $search = $search[ count( $search ) - 1 ];
+    }
+
+    $search = trim( $search );
 
     /**
@@ -139 +139 @@
      * @since 4.0.0
      *
-     * @param int         $characters The minimum number of characters required. Default 2.
-     * @param WP_Taxonomy $tax        The taxonomy object.
-     * @param string      $s          The search term.
+     * @param int         $characters      The minimum number of characters required. Default 2.
+     * @param WP_Taxonomy $taxonomy_object The taxonomy object.
+     * @param string      $search          The search term.
      */
-    $term_search_min_chars = (int) apply_filters( 'term_search_min_chars', 2, $tax, $s );
+    $term_search_min_chars = (int) apply_filters( 'term_search_min_chars', 2, $taxonomy_object, $search );
 
     /*
@@ -149 +149 @@
      * ensure it's a non-negative, non-zero integer.
      */
-    if ( ( 0 == $term_search_min_chars ) || ( strlen( $s ) < $term_search_min_chars ) ) {
+    if ( ( 0 == $term_search_min_chars ) || ( strlen( $search ) < $term_search_min_chars ) ) {
         wp_die();
     }
@@ -156 +156 @@
         array(
             'taxonomy'   => $taxonomy,
-            'name__like' => $s,
+            'name__like' => $search,
             'fields'     => 'names',
             'hide_empty' => false,
@@ -168 +168 @@
      * @since 6.1.0
      *
-     * @param string[]    $results Array of term names.
-     * @param WP_Taxonomy $tax     The taxonomy object.
-     * @param string      $s       The search term.
+     * @param string[]    $results         Array of term names.
+     * @param WP_Taxonomy $taxonomy_object The taxonomy object.
+     * @param string      $search          The search term.
      */
-    $results = apply_filters( 'ajax_term_search_results', $results, $tax, $s );
+    $results = apply_filters( 'ajax_term_search_results', $results, $taxonomy_object, $search );
 
     echo implode( "\n", $results );
@@ -1022 +1022 @@
 
     check_ajax_referer( $action );
-    $tax = get_taxonomy( 'link_category' );
-
-    if ( ! current_user_can( $tax->cap->manage_terms ) ) {
+
+    $taxonomy_object = get_taxonomy( 'link_category' );
+
+    if ( ! current_user_can( $taxonomy_object->cap->manage_terms ) ) {
         wp_die( -1 );
     }
@@ -1068 +1069 @@
 function wp_ajax_add_tag() {
     check_ajax_referer( 'add-tag', '_wpnonce_add-tag' );
-    $taxonomy = ! empty( $_POST['taxonomy'] ) ? $_POST['taxonomy'] : 'post_tag';
-    $tax      = get_taxonomy( $taxonomy );
-
-    if ( ! current_user_can( $tax->cap->edit_terms ) ) {
+
+    $taxonomy        = ! empty( $_POST['taxonomy'] ) ? $_POST['taxonomy'] : 'post_tag';
+    $taxonomy_object = get_taxonomy( $taxonomy );
+
+    if ( ! current_user_can( $taxonomy_object->cap->edit_terms ) ) {
         wp_die( -1 );
     }
@@ -1123 +1125 @@
 
     $message = '';
-    if ( isset( $messages[ $tax->name ][1] ) ) {
-        $message = $messages[ $tax->name ][1];
+    if ( isset( $messages[ $taxonomy_object->name ][1] ) ) {
+        $message = $messages[ $taxonomy_object->name ][1];
     } elseif ( isset( $messages['_item'][1] ) ) {
         $message = $messages['_item'][1];
@@ -1162 +1164 @@
     }
 
-    $taxonomy = sanitize_key( $_POST['tax'] );
-    $tax      = get_taxonomy( $taxonomy );
-
-    if ( ! $tax ) {
+    $taxonomy        = sanitize_key( $_POST['tax'] );
+    $taxonomy_object = get_taxonomy( $taxonomy );
+
+    if ( ! $taxonomy_object ) {
         wp_die( 0 );
     }
 
-    if ( ! current_user_can( $tax->cap->assign_terms ) ) {
+    if ( ! current_user_can( $taxonomy_object->cap->assign_terms ) ) {
         wp_die( -1 );
     }
@@ -1183 +1185 @@
 
     if ( empty( $tags ) ) {
-        wp_die( $tax->labels->not_found );
+        wp_die( $taxonomy_object->labels->not_found );
     }
 
@@ -2144 +2146 @@
     check_ajax_referer( 'taxinlineeditnonce', '_inline_edit' );
 
-    $taxonomy = sanitize_key( $_POST['taxonomy'] );
-    $tax      = get_taxonomy( $taxonomy );
-
-    if ( ! $tax ) {
+    $taxonomy        = sanitize_key( $_POST['taxonomy'] );
+    $taxonomy_object = get_taxonomy( $taxonomy );
+
+    if ( ! $taxonomy_object ) {
         wp_die( 0 );
     }
@@ -2209 +2211 @@
     unset( $post_types['attachment'] );
 
-    $s    = wp_unslash( $_POST['ps'] );
     $args = array(
         'post_type'      => array_keys( $post_types ),
@@ -2216 +2217 @@
     );
 
-    if ( '' !== $s ) {
-        $args['s'] = $s;
+    $search = wp_unslash( $_POST['ps'] );
+
+    if ( '' !== $search ) {
+        $args['s'] = $search;
     }