WordPress.org

Make WordPress Core

Opened 5 years ago

Closed 5 years ago

#27716 closed defect (bug) (fixed)

Hook Docs (69): wp-includes/link-template.php

Reported by: johnbillion Owned by: DrewAPicture
Milestone: 3.9 Priority: normal
Severity: normal Version:
Component: General Keywords: has-patch dev-reviewed commit
Focuses: docs Cc:

Description

Documentation needed for the following hooks:

*the_permalink
*user_trailingslashit
*pre_post_link
*post_link_category
*post_link
*post_type_link
*page_link
*_get_page_link
*attachment_link
*year_link
*month_link
*day_link
*the_feed_link
*feed_link
*post_comments_feed_link
*post_comments_feed_link_html
*author_feed_link
*category_feed_link
*tag_feed_link
*taxonomy_feed_link
*get_edit_tag_link
*edit_tag_link
*get_edit_term_link
*edit_term_link
*search_link
*search_feed_link
*search_feed_link
*post_type_archive_link
*post_type_archive_feed_link
*get_edit_post_link
*edit_post_link
*get_delete_post_link
*get_edit_comment_link
*edit_comment_link
*get_edit_bookmark_link
*edit_bookmark_link
*get_edit_user_link
*get_{$adjacent}_post_join
*get_{$adjacent}_post_where
*get_{$adjacent}_post_sort
*{$adjacent}_post_rel_link
*{$adjacent}_post_link
*get_pagenum_link
*next_posts_link_attributes
*previous_posts_link_attributes
*get_comments_pagenum_link
*next_comments_link_attributes
*previous_comments_link_attributes
*shortcut_link
*home_url
*site_url
*admin_url
*includes_url
*content_url
*plugins_url
*network_site_url
*network_home_url
*network_admin_url
*user_admin_url
*set_url_scheme
*user_dashboard_url
*edit_profile_url
*pre_get_shortlink
*get_shortlink
*the_shortlink

Attachments (2)

27716.patch (31.4 KB) - added by johnbillion 5 years ago.
27716.2.patch (33.3 KB) - added by DrewAPicture 5 years ago.
Final pass.

Download all attachments as: .zip

Change History (14)

#1 @johnbillion
5 years ago

  • Owner set to johnbillion
  • Status changed from new to assigned

I'm on it.

This ticket was mentioned in IRC in #wordpress-dev by DrewAPicture. View the logs.


5 years ago

@johnbillion
5 years ago

#3 @johnbillion
5 years ago

  • Keywords has-patch added; needs-patch removed
  • Milestone changed from Awaiting Review to 3.9

Patch

#4 @DrewAPicture
5 years ago

  • Owner changed from johnbillion to DrewAPicture
  • Status changed from assigned to reviewing

Thanks John, I'll take a look and probably just iterate on your patch with feedback.

#5 @DrewAPicture
5 years ago

  • Reporter changed from DrewAPicture to johnbillion

#6 follow-up: @SergeyBiryukov
5 years ago

27716.patch changes @since for site_url() from 2.6.0 to 3.0.0. However, the function was actually added in 2.6.0, see [7998].

#7 in reply to: ↑ 6 @DrewAPicture
5 years ago

Replying to SergeyBiryukov:

27716.patch changes @since for site_url() from 2.6.0 to 3.0.0. However, the function was actually added in 2.6.0, see [7998].

Thanks Sergey. These days, I usually check all the @since versions one by one on commit. Thanks for saving me some time :-)

#8 @nacin
5 years ago

Only thing I'll point out is that if the line preceding the doc block is at the same level of indentation, then there should be a blank line. It happens a lot throughout this file. No pressing need to fix it for now as it's pretty tedious; I was going to write a script to clean this up post 3.9.

I'm fine with this patch, including the few code changes.

#9 @nacin
5 years ago

  • Keywords dev-reviewed added

@DrewAPicture
5 years ago

Final pass.

#10 @DrewAPicture
5 years ago

  • Keywords commit added

27716.2.patch fixes a whole bunch of @since versions and standardizes language with related hooks.

This ticket was mentioned in IRC in #wordpress-dev by DrewAPicture. View the logs.


5 years ago

#12 @DrewAPicture
5 years ago

  • Resolution set to fixed
  • Status changed from reviewing to closed

In 28111:

Inline documentation for hooks in wp-includes/link-template.php.

Props johnbillion, DrewAPicture.
Fixes #27716.

Note: See TracTickets for help on using tickets.