Context Navigation

← Previous Change
Next Change →

link-template.php

Timestamp:

07/18/2022 05:35:51 PM (4 years ago)

Author:

SergeyBiryukov

Message:

Posts, Post Types: Standardize on $post parameter name where appropriate.

This renames the $post_id or $id parameters to $post for functions that accept a post ID or post object:

get_sample_permalink()
get_sample_permalink_html()
wp_check_post_lock()
wp_set_post_lock()
get_the_tags()
comment_class()
get_comment_class()
get_comments_link()
get_comments_number()
comments_number()
get_comments_number_text()
comments_open()
pings_open()
comment_form()
do_trackbacks()
pingback()
post_permalink()
get_post_permalink()
get_edit_post_link()
edit_post_link()
get_delete_post_link()
post_class()
get_post_class()
the_attachment_link()
wp_get_attachment_link()
wp_list_post_revisions()
check_and_publish_future_post()
add_ping()
get_pung()
get_to_ping()
wp_get_post_revisions()
wp_get_post_revisions_url()

Additionally, $revision_id is renamed to $revision in:

wp_restore_post_revision()
wp_delete_post_revision()

Includes minor documentation improvements for consistency and code layout fixes for better readability.

Follow-up to [1599], [1794], [2881], [3303], [3851], [5302], [6633], [6716], [6985], [7103], [7149], [7747], [8011], [8638], [8643], [8695], [9138], [9273], [11425], [11922], [11956], [12284], [12810], [12923], [13023], [13171], [25567], [27156], [27473], [28558], [28602], [33659], [38852], [47276], [47366], [48622], [49544], [49597], [52095].

See #56243, #55647.

File:

: 1 edited

trunk/src/wp-includes/link-template.php (modified) (11 diffs)

Legend:

: Unmodified
: Added
: Removed

trunk/src/wp-includes/link-template.php

-              r53520
+              r53715
  * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
+ *
  * @param int|WP_Post $id        Optional. Post ID or post object. Default is the global `$post`.
+ * @param int|WP_Post $post      Optional. Post ID or post object. Default is the global `$post`.
  * @param bool        $leavename Optional. Whether to keep post name. Default false.
  * @param bool        $sample    Optional. Is it a sample permalink. Default false.
  * @return string|WP_Error The post permalink.
  */
 function get_post_permalink( $id = 0, $leavename = false, $sample = false ) {
+function get_post_permalink( $post = 0, $leavename = false, $sample = false ) {
         global $wp_rewrite;
         $post = get_post( $id );
+        $post = get_post( $post );
         if ( is_wp_error( $post ) ) {
 …
         $post_type_obj = get_post_type_object( $post_type );
         if ( ! $post_type_obj ) {
                 return false;
 …
 function get_preview_post_link( $post = null, $query_args = array(), $preview_link = '' ) {
         $post = get_post( $post );
         if ( ! $post ) {
                 return;
 …
  * @since 2.3.0
+ *
  * @param int|WP_Post $id      Optional. Post ID or post object. Default is the global `$post`.
+ * @param int|WP_Post $post    Optional. Post ID or post object. Default is the global `$post`.
  * @param string      $context Optional. How to output the '&' character. Default '&amp;'.
  * @return string|null The edit post link for the given post. Null if the post type does not exist
  *                     or does not allow an editing UI.
  */
+function get_edit_post_link( $id = 0, $context = 'display' ) {
+        $post = get_post( $id );
+function get_edit_post_link( $post = 0, $context = 'display' ) {
+        $post = get_post( $post );
         if ( ! $post ) {
                 return;
 …
         $post_type_object = get_post_type_object( $post->post_type );
         if ( ! $post_type_object ) {
                 return;
 …
  * @param string      $before Optional. Display before edit link. Default empty.
  * @param string      $after  Optional. Display after edit link. Default empty.
  * @param int|WP_Post $id     Optional. Post ID or post object. Default is the global `$post`.
+ * @param int|WP_Post $post   Optional. Post ID or post object. Default is the global `$post`.
  * @param string      $class  Optional. Add custom class to link. Default 'post-edit-link'.
  */
+function edit_post_link( $text = null, $before = '', $after = '', $id = 0, $class = 'post-edit-link' ) {
+        $post = get_post( $id );
+function edit_post_link( $text = null, $before = '', $after = '', $post = 0, $class = 'post-edit-link' ) {
+        $post = get_post( $post );
         if ( ! $post ) {
                 return;
 …
         $url = get_edit_post_link( $post->ID );
         if ( ! $url ) {
                 return;
 …
  * @since 2.9.0
+ *
  * @param int|WP_Post $id           Optional. Post ID or post object. Default is the global `$post`.
+ * @param int|WP_Post $post         Optional. Post ID or post object. Default is the global `$post`.
  * @param string      $deprecated   Not used.
  * @param bool        $force_delete Optional. Whether to bypass Trash and force deletion. Default false.
  * @return string|void The delete post link URL for the given post.
  */
 function get_delete_post_link( $id = 0, $deprecated = '', $force_delete = false ) {
+function get_delete_post_link( $post = 0, $deprecated = '', $force_delete = false ) {
         if ( ! empty( $deprecated ) ) {
                 _deprecated_argument( __FUNCTION__, '3.0.0' );
+        }
+        $post = get_post( $id );
+        $post = get_post( $post );
         if ( ! $post ) {
                 return;
 …
         $post_type_object = get_post_type_object( $post->post_type );
         if ( ! $post_type_object ) {
                 return;
 …
         $post = get_post();
         if ( ! $post || ! taxonomy_exists( $taxonomy ) ) {
                 return null;
 …
 function get_boundary_post( $in_same_term = false, $excluded_terms = '', $start = true, $taxonomy = 'category' ) {
         $post = get_post();
         if ( ! $post || ! is_single() || is_attachment() || ! taxonomy_exists( $taxonomy ) ) {
                 return null;

Note: See TracChangeset for help on using the changeset viewer.

Make WordPress Core

Context Navigation

Changeset 53715 for trunk/src/wp-includes/link-template.php

Legend:

trunk/src/wp-includes/link-template.php

Download in other formats: