Ticket #35148: post.php.patch

wp-includes/post.php

@@ -170 +170 @@
  * Retrieve attached file path based on attachment ID.
  *
  * By default the path will go through the 'get_attached_file' filter, but
- * passing a true to the $unfiltered argument of get_attached_file() will
+ * passing a true to the $unfiltered argument of {@see get_attached_file()} will
  * return the file path unfiltered.
  *
  * The function works by getting the single post meta name, named
@@ -948 +948 @@
  *     @type array       $supports             An alias for calling {@see add_post_type_support()} directly.
  *                                             Defaults to array containing 'title' & 'editor'.
  *     @type callable    $register_meta_box_cb Provide a callback function that sets up the meta boxes for the
- *                                             edit form. Do remove_meta_box() and add_meta_box() calls in the
+ *                                             edit form. Do {@see remove_meta_box()} and {@see add_meta_box()} calls in the
  *                                             callback. Default null.
  *     @type array       $taxonomies           An array of taxonomy identifiers that will be registered for the
  *                                             post type. Taxonomies can be registered later with
@@ -1215 +1215 @@
  *
  * These four primitive capabilities are checked in core in various locations.
  * There are also seven other primitive capabilities which are not referenced
- * directly in core, except in map_meta_cap(), which takes the three aforementioned
+ * directly in core, except in {@see map_meta_cap()}, which takes the three aforementioned
  * meta capabilities and translates them into one or more primitive capabilities
  * that must then be checked against the user or role, depending on the context.
  *
@@ -1229 +1229 @@
  * - edit_private_posts - Controls whether private objects can be edited.
  * - edit_published_posts - Controls whether published objects can be edited.
  *
- * These additional capabilities are only used in map_meta_cap(). Thus, they are
+ * These additional capabilities are only used in {@see map_meta_cap()}. Thus, they are
  * only assigned by default if the post type is registered with the 'map_meta_cap'
  * argument set to true (default is false).
  *
@@ -1288 +1288 @@
 }
 
 /**
- * Store or return a list of post type meta caps for map_meta_cap().
+ * Store or return a list of post type meta caps for {@see map_meta_cap()}.
  *
  * @since 3.1.0
  * @access private
@@ -2081 +2081 @@
 }
 
 /**
- * Return the cache key for wp_count_posts() based on the passed arguments.
+ * Return the cache key for {@see wp_count_posts()} based on the passed arguments.
  *
  * @since 3.9.0
  *
@@ -2105 +2105 @@
  *
  * This function provides an efficient method of finding the amount of post's
  * type a blog has. Another method is to count the amount of items in
- * get_posts(), but that method has a lot of overhead with doing so. Therefore,
+ * {@see get_posts()}, but that method has a lot of overhead with doing so. Therefore,
  * when developing for 2.5+, use this function instead.
  *
  * The $perm parameter checks for 'readable' value and if the user can read
@@ -2383 +2383 @@
         }
 
         /**
-         * Fires before a post is deleted, at the start of wp_delete_post().
+         * Fires before a post is deleted, at the start of {@see wp_delete_post()}.
          *
          * @since 3.2.0
          *
@@ -2410 +2410 @@
                 }
         }
 
-        // Do raw query. wp_get_post_revisions() is filtered.
+        // Do raw query. {@see wp_get_post_revisions()} is filtered.
         $revision_ids = $wpdb->get_col( $wpdb->prepare( "SELECT ID FROM $wpdb->posts WHERE post_parent = %d AND post_type = 'revision'", $postid ) );
         // Use wp_delete_post (via wp_delete_post_revision) again. Ensures any meta/misplaced data gets cleaned up.
         foreach ( $revision_ids as $revision_id )
@@ -2464 +2464 @@
         wp_clear_scheduled_hook('publish_future_post', array( $postid ) );
 
         /**
-         * Fires after a post is deleted, at the conclusion of wp_delete_post().
+         * Fires after a post is deleted, at the conclusion of {@see wp_delete_post()}.
          *
          * @since 3.2.0
          *
@@ -4057 +4057 @@
 /**
  * Retrieves page data given a page ID or page object.
  *
- * Use get_post() instead of get_page().
+ * Use {@see get_post()} instead of get_page().
  *
  * @since 1.5.1
  * @deprecated 3.5.0 Use get_post()
@@ -4606 +4606 @@
          * @since 2.1.0
          *
          * @param array $pages List of pages to retrieve.
-         * @param array $r     Array of get_pages() arguments.
+         * @param array $r     Array of {@see get_pages()} arguments.
          */
         return apply_filters( 'get_pages', $pages, $r );
 }
@@ -4718 +4718 @@
                 delete_transient( 'dirsize_cache' );
 
         /**
-         * Fires before an attachment is deleted, at the start of wp_delete_attachment().
+         * Fires before an attachment is deleted, at the start of {@see wp_delete_attachment()}.
          *
          * @since 2.0.0
          *
@@ -5035 +5035 @@
  * Checks if the attachment is an image.
  *
  * @since 2.1.0
- * @since 4.2.0 Modified into wrapper for wp_attachment_is() and
+ * @since 4.2.0 Modified into wrapper for {@see wp_attachment_is()} and
  *              allowed WP_Post object to be passed.
  *
  * @param int|WP_Post $post Optional. Attachment ID. Default 0.
@@ -5366 +5366 @@
  */
 function get_lastpostmodified( $timezone = 'server', $post_type = 'any' ) {
         /**
-         * Pre-filter the return value of get_lastpostmodified() before the query is run.
+         * Pre-filter the return value of {@see get_lastpostmodified()} before the query is run.
          *
          * @since 4.4.0
          *
@@ -5409 +5409 @@
  *
  * @global wpdb $wpdb WordPress database abstraction object.
  *
- * @param string $timezone  The timezone for the timestamp. See get_lastpostdate().
+ * @param string $timezone  The timezone for the timestamp. See {@see get_lastpostdate()}.
  *                          for information on accepted values.
  * @param string $field     Post field to check. Accepts 'date' or 'modified'.
  * @param string $post_type Optional. The post type to check. Default 'any'.
@@ -5483 +5483 @@
  * object cache associated with the post ID.
  *
  * This function not run if $_wp_suspend_cache_invalidation is not empty. See
- * wp_suspend_cache_invalidation().
+ * {@see wp_suspend_cache_invalidation()}.
  *
  * @since 2.0.0
  *
@@ -5699 +5699 @@
  * @access private
  *
  * @param int     $deprecated Not used. Can be set to null. Never implemented. Not marked
- *                            as deprecated with _deprecated_argument() as it conflicts with
- *                            wp_transition_post_status() and the default filter for
+ *                            as deprecated with {@see _deprecated_argument()} as it conflicts with
+ *                            {@see wp_transition_post_status()} and the default filter for
  *                            {@see _future_post_hook()}.
  * @param WP_Post $post       Post object.
  */
@@ -5722 +5722 @@
 function _publish_post_hook( $post_id ) {
         if ( defined( 'XMLRPC_REQUEST' ) ) {
                 /**
-                 * Fires when _publish_post_hook() is called during an XML-RPC request.
+                 * Fires when {@see _publish_post_hook()} is called during an XML-RPC request.
                  *
                  * @since 2.1.0
                  *