Changeset 55365 for trunk/src/wp-includes/class-wp-embed.php

Timestamp:

02/19/2023 03:03:50 PM (2 years ago)

Author:

SergeyBiryukov

Message:

Coding Standards: Rename $post_ID variable to $post_id in various files.

The $post_ID variable is ​technically allowed in WPCS, as there is a global of the same name that needs to remain for backward compatibility. However, this name is mostly a remnant of legacy code, and switching to $post_id where appropriate brings more consistency with the rest of core.

Additionally, this commit resolves a few WPCS warnings in core:

Variable "$post_IDs" is not in valid snake_case format

This affects:

• Function parameters in:
  • add_meta()
  • post_preview()
  • WP_Embed::delete_oembed_caches()
  • WP_Embed::cache_oembed()
  • wp_get_post_cats()
  • wp_set_post_cats()
  • wp_unique_post_slug()
  • wp_set_post_categories()
  • wp_check_post_hierarchy_for_loops()
  • wp_add_trashed_suffix_to_post_name_for_trashed_posts()
  • wp_filter_wp_template_unique_post_slug()
  • wp_xmlrpc_server::add_enclosure_if_new()
  • wp_xmlrpc_server::attach_uploads()
  • wp_xmlrpc_server::mt_getTrackbackPings()
• Internal variables in:
  • wp_ajax_inline_save()
  • wp_ajax_set_post_thumbnail()
  • wp_ajax_get_post_thumbnail_html()
  • edit_post()
  • bulk_edit_posts()
  • wp_write_post()
  • WP_Embed::shortcode()
  • wp_insert_post()
  • wp_xmlrpc_server::_insert_post()
  • wp_xmlrpc_server::blogger_getPost()
  • wp_xmlrpc_server::blogger_newPost()
  • wp_xmlrpc_server::blogger_editPost()
  • wp_xmlrpc_server::blogger_deletePost()
  • wp_xmlrpc_server::mw_getPost()
  • wp_xmlrpc_server::mw_newPost()
  • wp_xmlrpc_server::mw_editPost()
  • wp_xmlrpc_server::mt_getPostCategories()
  • wp_xmlrpc_server::mt_setPostCategories()
  • wp_xmlrpc_server::mt_publishPost()
  • wp_xmlrpc_server::pingback_ping()
• Hook parameters in:
  • oembed_ttl
  • embed_oembed_html
  • wp_insert_post_parent
  • add_trashed_suffix_to_trashed_posts
  • pre_post_update
  • edit_attachment
  • attachment_updated
  • add_attachment
  • edit_post_{$post->post_type}
  • edit_post
  • post_updated
  • save_post_{$post->post_type}
  • save_post
  • wp_insert_post
  • pre_wp_unique_post_slug
  • wp_unique_post_slug
  • xmlrpc_call_success_blogger_newPost
  • xmlrpc_call_success_blogger_editPost
  • xmlrpc_call_success_blogger_deletePost
  • xmlrpc_call_success_mw_newPost
  • xmlrpc_call_success_mw_editPost

Note: The name change only affects variable names and DocBlocks.

The change does not affect the $post_ID global still used in a few places.

Follow-up to [51399], [52958], [53723], [53729], [55190], [55308], [55334].

Props mahekkalola, tanjimtc71, SergeyBiryukov.
Fixes #57692.

File:

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

trunk/src/wp-includes/class-wp-embed.php

@@ -223 +223 @@
         }
 
-        $post_ID = ( ! empty( $post->ID ) ) ? $post->ID : null;
+        $post_id = ( ! empty( $post->ID ) ) ? $post->ID : null;
 
         // Potentially set by WP_Embed::cache_oembed().
         if ( ! empty( $this->post_ID ) ) {
-            $post_ID = $this->post_ID;
+            $post_id = $this->post_ID;
         }
 
@@ -243 +243 @@
          * @param string $url     The attempted embed URL.
          * @param array  $attr    An array of shortcode attributes.
-         * @param int    $post_ID Post ID.
+         * @param int    $post_id Post ID.
          */
-        $ttl = apply_filters( 'oembed_ttl', DAY_IN_SECONDS, $url, $attr, $post_ID );
+        $ttl = apply_filters( 'oembed_ttl', DAY_IN_SECONDS, $url, $attr, $post_id );
 
         $cache      = '';
@@ -252 +252 @@
         $cached_post_id = $this->find_oembed_post_id( $key_suffix );
 
-        if ( $post_ID ) {
-            $cache      = get_post_meta( $post_ID, $cachekey, true );
-            $cache_time = get_post_meta( $post_ID, $cachekey_time, true );
+        if ( $post_id ) {
+            $cache      = get_post_meta( $post_id, $cachekey, true );
+            $cache_time = get_post_meta( $post_id, $cachekey_time, true );
 
             if ( ! $cache_time ) {
@@ -285 +285 @@
                  * @param string       $url     The attempted embed URL.
                  * @param array        $attr    An array of shortcode attributes.
-                 * @param int          $post_ID Post ID.
+                 * @param int          $post_id Post ID.
                  */
-                return apply_filters( 'embed_oembed_html', $cache, $url, $attr, $post_ID );
+                return apply_filters( 'embed_oembed_html', $cache, $url, $attr, $post_id );
             }
         }
@@ -306 +306 @@
         $html = wp_oembed_get( $url, $attr );
 
-        if ( $post_ID ) {
+        if ( $post_id ) {
             if ( $html ) {
-                update_post_meta( $post_ID, $cachekey, $html );
-                update_post_meta( $post_ID, $cachekey_time, time() );
+                update_post_meta( $post_id, $cachekey, $html );
+                update_post_meta( $post_id, $cachekey_time, time() );
             } elseif ( ! $cache ) {
-                update_post_meta( $post_ID, $cachekey, '{{unknown}}' );
+                update_post_meta( $post_id, $cachekey, '{{unknown}}' );
             }
         } else {
@@ -370 +370 @@
         if ( $html ) {
             /** This filter is documented in wp-includes/class-wp-embed.php */
-            return apply_filters( 'embed_oembed_html', $html, $url, $attr, $post_ID );
+            return apply_filters( 'embed_oembed_html', $html, $url, $attr, $post_id );
         }
 
@@ -380 +380 @@
      * Deletes all oEmbed caches. Unused by core as of 4.0.0.
      *
-     * @param int $post_ID Post ID to delete the caches for.
-     */
-    public function delete_oembed_caches( $post_ID ) {
-        $post_metas = get_post_custom_keys( $post_ID );
+     * @param int $post_id Post ID to delete the caches for.
+     */
+    public function delete_oembed_caches( $post_id ) {
+        $post_metas = get_post_custom_keys( $post_id );
         if ( empty( $post_metas ) ) {
             return;
@@ -390 +390 @@
         foreach ( $post_metas as $post_meta_key ) {
             if ( '_oembed_' === substr( $post_meta_key, 0, 8 ) ) {
-                delete_post_meta( $post_ID, $post_meta_key );
+                delete_post_meta( $post_id, $post_meta_key );
             }
         }
@@ -398 +398 @@
      * Triggers a caching of all oEmbed results.
      *
-     * @param int $post_ID Post ID to do the caching for.
-     */
-    public function cache_oembed( $post_ID ) {
-        $post = get_post( $post_ID );
+     * @param int $post_id Post ID to do the caching for.
+     */
+    public function cache_oembed( $post_id ) {
+        $post = get_post( $post_id );
 
         $post_types = get_post_types( array( 'show_ui' => true ) );