Commit Graph

280 Commits

Author SHA1 Message Date
Drew Jaynes ad297dab6d Correctly capitalize JavaScript throughout core docs.
Fixes #30569.

Built from https://develop.svn.wordpress.org/trunk@30695


git-svn-id: http://core.svn.wordpress.org/trunk@30685 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-12-02 00:31:22 +00:00
Scott Taylor e619abda6e Improve various `@param` docs for `src/wp-includes/*`.
See #30224.

Built from https://develop.svn.wordpress.org/trunk@30681


git-svn-id: http://core.svn.wordpress.org/trunk@30671 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-12-01 01:34:24 +00:00
Drew Jaynes bffe95d34c Docs Formatting: Backtick-escape inline code for all remaining dynamic hook docs in wp-includes/*.
Affects DocBlocks for the following hooks:
* `auth_post_meta_{$meta_key}`
* `term_links-$taxonomy`
* `customize_render_control_ . $this->id`
* `customize_render_panel_{$this->id}`
* `customize_render_section_{$this->id}`
* `customize_preview_{$this->id}`
* `customize_save_ . $this->id_data[ 'base' ]`
* `customize_update_ . $this->type`
* `customize_value_ . $this->id_data[ 'base' ]`
* `customize_sanitize_js_{$this->id}`
* `comment_form_field_{$name}`
* `comment_{$old_status}_to_{$new_status}`
* `comment_{$new_status}_{$comment->comment_type}`
* `extra_{$context}_headers`
* `get_template_part_{$slug}`
* `get_the_generator_{$type}`
* `get_{$adjacent}_post_join`
* `get_{$adjacent}_post_where`
* `get_{$adjacent}_post_sort`
* `{$adjacent}_post_rel_link`
* `{$adjacent}_post_link`
* `{$adjacent}_image_link`
* `blog_option_{$option}`
* `$permastructname . _rewrite_rules`
* `{$type}_template`
* `theme_mod_{$name}`
* `pre_set_theme_mod_$name`
* `current_theme_supports-{$feature}`
* `get_user_option_{$option}`
* `edit_user_{$field}`
* `pre_user_{$field}`
* `user_{$field}`

See #30552.

Built from https://develop.svn.wordpress.org/trunk@30656


git-svn-id: http://core.svn.wordpress.org/trunk@30646 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-11-30 12:10:23 +00:00
Drew Jaynes 4432dc752b 4.1 Docs Audit: Various formatting fixes for inline documentation in class-wp-list-table.php and comment-template.php.
See #30469.

Built from https://develop.svn.wordpress.org/trunk@30610


git-svn-id: http://core.svn.wordpress.org/trunk@30600 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-11-28 11:22:23 +00:00
Peter Westwood 6c40c6f2e2 Fix the passing of commenter cookie data to the comment API so that we don't try and fetch all unapproved comments for users with no-email address when we only have an author.
Fixes #19623

Built from https://develop.svn.wordpress.org/trunk@30547


git-svn-id: http://core.svn.wordpress.org/trunk@30536 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-11-24 10:51:22 +00:00
Drew Jaynes de809a5a86 Ensure inline code is markdown-escaped as such, HTML tags are removed from summaries, and that code snippets in descriptions are properly indented.
Affects DocBlocks for the following core elements:
* Remove HTML tag from parameter description in `comment_form()`
* Remove HTML tag from a summary for the `comment_form_top` hook
* Markdown-indent a code snippet in the description for `get_linkobjectsbyname()`
* Markdown-indent a code snippet and format an unordered list in the description for `get_linkobjects()`
* Backtick-escape some inline code in the description for `clean_pre()`
* Remove HTML tag from the summary for the `rss_tag_pre` hook
* Various formatting fixes in the descriptions for `get_filesystem_method()` and `request_filesystem_credentials()`

Props rarst for the initial patch.
See #30473.

Built from https://develop.svn.wordpress.org/trunk@30538


git-svn-id: http://core.svn.wordpress.org/trunk@30527 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-11-24 05:19:23 +00:00
Drew Jaynes 39a44f62ad Update the changelogs for the comment hook parameters added in [30092].
Parameters were added to the `get_comment_author`, `comment_author`, `get_comment_author_email`, `author_email`, `comment_email`, `get_comment_author_link`, `get_comment_author_IP`, `get_comment_author_url`, `comment_url`, `get_comment_excerpt`, `comment_excerpt`, `get_comment_ID`, and `get_comment_type` filters.

Fixes #22380.

Built from https://develop.svn.wordpress.org/trunk@30111


git-svn-id: http://core.svn.wordpress.org/trunk@30111 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-10-30 03:52:22 +00:00
Peter Westwood 664f19e28a Comment Template Tags: Improve the availability of context information in comment template tag filters.
Fixes #22380 props momo360modena, tareq1988.

Built from https://develop.svn.wordpress.org/trunk@30092


git-svn-id: http://core.svn.wordpress.org/trunk@30092 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-10-29 19:07:22 +00:00
Sergey Biryukov 0c2c7ad204 Add 'comment_reply_link_args' filter for get_comment_reply_link() arguments.
props joedolson, aaroncampbell, DrewAPicture.
fixes #10569.
Built from https://develop.svn.wordpress.org/trunk@30039


git-svn-id: http://core.svn.wordpress.org/trunk@30039 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-10-27 11:45:18 +00:00
Boone Gorges 304802d70d Use the comment API rather than direct SQL queries in `comments_template()`.
`comments_template()` is used by most themes to display a post's comments. It
shows all comments that have been approved, and also shows all pending comments
by the current visitor (as determined by the comment cookies). However, the
comments API previously had no way of querying for "all comments that are
either approved, or are unapproved but written by foo@example.com". The
workaround was a direct SQL query: uncached, not subject to the same filters as
other comment queries, and just generally icky.

The new `include_unapproved` parameter for `WP_Comment_Query` accepts an array
of user IDs or email addresses. Pending comments associated with users in this
array will be included in query results, regardless of the value of the 'status'
parameter. In `comments_template()`, we leap from direct SQL queries to
`get_comments()` plus `include_unapproved', striving to put right what once
went wrong.

Props boonebgorges, simonwheatley, hardy101, jesin.
Fixes #19623.
Built from https://develop.svn.wordpress.org/trunk@29965


git-svn-id: http://core.svn.wordpress.org/trunk@29712 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-10-19 19:39:20 +00:00
Dominik Schilling bf16aac8e1 Comments: Don't print an empty HTML markup when `comment_reply_link()` returns no link.
props obenland.
fixes #29895.
Built from https://develop.svn.wordpress.org/trunk@29908


git-svn-id: http://core.svn.wordpress.org/trunk@29662 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-10-15 21:56:19 +00:00
Sergey Biryukov 965b6d54b6 Add aria-describedby attributes to comment_form().
props joedolson, bramd.
fixes #24148.
Built from https://develop.svn.wordpress.org/trunk@29846


git-svn-id: http://core.svn.wordpress.org/trunk@29609 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-10-06 22:11:15 +00:00
Sergey Biryukov 6d0f2dcf11 Make link construction in get_comment_reply_link() and get_post_reply_link() more readable.
see #16433.
Built from https://develop.svn.wordpress.org/trunk@29823


git-svn-id: http://core.svn.wordpress.org/trunk@29589 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-10-02 20:45:16 +00:00
Sergey Biryukov 70c88e59b1 Add an aria-label attribute with commenter's name to get_comment_reply_link().
props joedolson, merty, andrewryno.
fixes #16433.
Built from https://develop.svn.wordpress.org/trunk@29822


git-svn-id: http://core.svn.wordpress.org/trunk@29588 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-10-02 20:41:16 +00:00
Sergey Biryukov 0797823c55 Add a class attribute for submit button in comment form.
props bainternet.
fixes #20446.
Built from https://develop.svn.wordpress.org/trunk@29809


git-svn-id: http://core.svn.wordpress.org/trunk@29575 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-10-02 01:44:15 +00:00
Scott Taylor 0005433983 Correct a few `@param` docs for `$walker`.
Props dnaber-de.
Fixes #29011.

Built from https://develop.svn.wordpress.org/trunk@29293


git-svn-id: http://core.svn.wordpress.org/trunk@29075 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-07-24 22:25:16 +00:00
Drew Jaynes c5a59037f1 Inline documentation cleanup for 4.0 audit.
Various improvements:
* Adds `@see` reference for `wp_list_comments()` in 'wp_list_comments_args' filter docs, added in [28285]
* Various phpDoc tweaks for the 'run_wptexturize' filter docs, added in [28715]
* Sentence and wrapping changes for `is_https_url()`, added in [28894]
* Documents the `$args` parameter for `wp_dropdown_languages()`, added in [29007]
* Adds a period to the parameter description for `_update_posts_count_on_delete()`, added in [28835]
* Documents a global in `is_customize_preview()`, added in [28999]
* phpDoc tweaks, adds an access modifier for `wpdb::esc_like()`, added in [28711]

See #28885.

Built from https://develop.svn.wordpress.org/trunk@29163


git-svn-id: http://core.svn.wordpress.org/trunk@28947 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-07-14 01:02:15 +00:00
Scott Taylor ef436cb6e0 Revert [28563]. See #18298.
Built from https://develop.svn.wordpress.org/trunk@29044


git-svn-id: http://core.svn.wordpress.org/trunk@28832 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-07-09 18:07:16 +00:00
Drew Jaynes d4dd02b4ae Remove backticks on `$post` variables in some short parameter descriptions.
See [28653], [28654].
See #28388.

Built from https://develop.svn.wordpress.org/trunk@28976


git-svn-id: http://core.svn.wordpress.org/trunk@28765 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-07-03 19:28:14 +00:00
Scott Taylor 21864a98d0 Add a function, `get_comments_number_text()`, that returns instead of echoing. `comments_number()` wraps it.
Props kapeels, nbachiyski.
Fixes #10177.

Built from https://develop.svn.wordpress.org/trunk@28912


git-svn-id: http://core.svn.wordpress.org/trunk@28711 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-06-29 23:13:15 +00:00
Scott Taylor 0ba605c55c Ensure that a `has_children` parameter is given to `Walker::start_el()`.
Adds unit tests.

Props scribu, obenland.
Fixes #14041.

Built from https://develop.svn.wordpress.org/trunk@28824


git-svn-id: http://core.svn.wordpress.org/trunk@28628 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-06-24 17:06:14 +00:00
Scott Taylor 919ff69120 In `comment_form()`, allow `name_submit` to be passed to change the `name` attribute of the submit button.
Props obenland.
Fixes #22792.

Built from https://develop.svn.wordpress.org/trunk@28813


git-svn-id: http://core.svn.wordpress.org/trunk@28620 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-06-24 00:10:15 +00:00
Drew Jaynes 3724252959 Ensure `$post_id` is documented as optional where applicable.
See #28388.

Built from https://develop.svn.wordpress.org/trunk@28654


git-svn-id: http://core.svn.wordpress.org/trunk@28472 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-06-03 04:44:16 +00:00
Scott Taylor 2d6721dbc9 Fix an error caused by [28604] in `get_comments_number()` unit tests.
Props SergeyBiryukov.
Fixes #26240.


Built from https://develop.svn.wordpress.org/trunk@28638


git-svn-id: http://core.svn.wordpress.org/trunk@28456 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-30 19:47:14 +00:00
Dominik Schilling d40280d0db Pass `$post->ID` to `get_comments_number` filter.
Also fixes indentation and a typo in corresponding filter docs.

see #26240.
Built from https://develop.svn.wordpress.org/trunk@28604


git-svn-id: http://core.svn.wordpress.org/trunk@28428 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-28 22:36:15 +00:00
Drew Jaynes 6989c5ab46 Fix parameter description for the `$post_id` argument in `get_comments_number()` to note that it is optional.
Also fixes the corresponding filter docs, as `$post_id`, not `$post` is passed to the filter.

See [27156]. Fixes #26240.

Built from https://develop.svn.wordpress.org/trunk@28602


git-svn-id: http://core.svn.wordpress.org/trunk@28427 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-28 22:05:18 +00:00
Scott Taylor b75c79500b Replaces all uses of `TEMPLATEPATH` and `STYLESHEETPATH` in core with `get_template_directory()` and `get_stylesheet_directory()`.
Add `@deprecated` annotations to `TEMPLATEPATH` and `STYLESHEETPATH` definitions.

Props obenland, aaroncampbell. 
Fixes #18298.

Built from https://develop.svn.wordpress.org/trunk@28563


git-svn-id: http://core.svn.wordpress.org/trunk@28389 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-23 20:12:15 +00:00
Scott Taylor e8181b0934 Allow `get_comments_number()` to officially accept `$post` or `$post_id`. Adds unit tests.
Props coffee2code, JanHenkG.
Fixes #26240.

Built from https://develop.svn.wordpress.org/trunk@28558


git-svn-id: http://core.svn.wordpress.org/trunk@28384 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-23 17:44:14 +00:00
Scott Taylor dfa4de15fa Add missing access modifiers to methods/members in `Walker` and subclasses. Add a magic `__get()` method.
See #27881, #22234.

Built from https://develop.svn.wordpress.org/trunk@28514


git-svn-id: http://core.svn.wordpress.org/trunk@28340 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-19 06:00:15 +00:00
Scott Taylor 78b6f2761d Eliminate use of `extract()` in `get_comment_reply_link()`.
See #22400.

Built from https://develop.svn.wordpress.org/trunk@28431


git-svn-id: http://core.svn.wordpress.org/trunk@28258 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-15 15:35:15 +00:00
Scott Taylor 7943f4715a Eliminate the use of `extract()` in `get_post_reply_link()`.
See #22400.

Built from https://develop.svn.wordpress.org/trunk@28429


git-svn-id: http://core.svn.wordpress.org/trunk@28256 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-15 06:49:14 +00:00
Scott Taylor 0e2909ce89 Eliminate the use of `extract()` in `wp_list_comments()`. All unit tests pass.
See #22400.

Built from https://develop.svn.wordpress.org/trunk@28428


git-svn-id: http://core.svn.wordpress.org/trunk@28255 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-15 06:43:15 +00:00
Scott Taylor de262f553c In `wp-includes/comment-template.php`, remove dead code:
* In `get_comment_reply_link()`, `$link` is set twice before it is used.
* In `Walker_Comment::start_lvl()`, `case 'ul':` is unreachable unless placed before `default:`. 
* In `Walker_Comment::end_lvl()`, `case 'ul':` is unreachable unless placed before `default:`.
* In `comment_form()`, `$id` is conditionally set and never used. 

See #27882.


Built from https://develop.svn.wordpress.org/trunk@28323


git-svn-id: http://core.svn.wordpress.org/trunk@28151 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-06 21:15:17 +00:00
Sergey Biryukov d70e8a38fa Add a filter for wp_list_comments() arguments.
props greenshady, hlashbrooke.
fixes #19581.
Built from https://develop.svn.wordpress.org/trunk@28285


git-svn-id: http://core.svn.wordpress.org/trunk@28113 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-06 11:58:14 +00:00
Drew Jaynes 5e51ea9940 Priority fixes for various existing hook documentation.
Props kpdesign.
See #26869

Built from https://develop.svn.wordpress.org/trunk@28083


git-svn-id: http://core.svn.wordpress.org/trunk@27914 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-04-12 00:01:15 +00:00
Drew Jaynes acf9fbc808 Remove a blank line and @global reference in the PHPDoc for `comment_author_email_link()`.
Props norcross, ocean90.
Fixes #27655.

Built from https://develop.svn.wordpress.org/trunk@27943


git-svn-id: http://core.svn.wordpress.org/trunk@27773 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-04-04 04:36:15 +00:00
Andrew Nacin 502ac958e5 Pass walker arguments to get_comment_link() so pagination works when wp_list_comments() is used outside the comment template.
props SergeyBiryukov.
fixes #27007.

Built from https://develop.svn.wordpress.org/trunk@27799


git-svn-id: http://core.svn.wordpress.org/trunk@27634 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-03-28 02:38:14 +00:00
Sergey Biryukov 8343fabff6 Avoid a notice in trackback_rdf() if user agent is not set.
props joostdevalk.
fixes #27374.
Built from https://develop.svn.wordpress.org/trunk@27514


git-svn-id: http://core.svn.wordpress.org/trunk@27357 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-03-12 12:54:15 +00:00
Andrew Nacin 1699153d26 Pass the comment object to the get_comment_date and get_comment_time.
props SergeyBiryukov.
fixes #19849.

Built from https://develop.svn.wordpress.org/trunk@27283


git-svn-id: http://core.svn.wordpress.org/trunk@27139 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-02-26 16:41:14 +00:00
Drew Jaynes cb8951b0b3 Remove all `@package` and `@subpackage` PHPDoc tags not at the file- or class-levels in core.
See #27200.

Built from https://develop.svn.wordpress.org/trunk@27262


git-svn-id: http://core.svn.wordpress.org/trunk@27119 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-02-25 17:14:14 +00:00
Drew Jaynes c8665c5973 Fix a typo in the PHPDoc for `comment_author_email_link()`.
See #27083.

Built from https://develop.svn.wordpress.org/trunk@27157


git-svn-id: http://core.svn.wordpress.org/trunk@27023 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-02-10 04:07:12 +00:00
Drew Jaynes 8eb2d3610b Inline documentation cleanup in wp-includes/comment-template.php.
This cleanup follows [25567] and brings the docs in-line with standards that at the time had not yet been finalized.

These changes include
* Moving in-line `@see` tags to their own lines
* Using docs-specific variables in hook docs
* Fixing line-wrapping throughout
* Typos and punctuation
* Converting hash notation values to variables per the standard

Fixes #27083. See #20495.

Built from https://develop.svn.wordpress.org/trunk@27156


git-svn-id: http://core.svn.wordpress.org/trunk@27022 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-02-10 03:20:12 +00:00
Drew Jaynes cd8cedc40d First there were two, and now there are three -- in the @since versions that came before and that shall be. And so it will be, says nacin.
Props JustinSainton, SergeyBiryukov, DrewAPicture.
Fixes #26713.

Built from https://develop.svn.wordpress.org/trunk@26868


git-svn-id: http://core.svn.wordpress.org/trunk@26754 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-12-24 18:57:12 +00:00
Andrew Nacin 808653e2a3 Add echo arguments to wp_list_comments() and Walker_Comment, allowing non-echo usage.
props mikelittle.
fixes #10948.

Built from https://develop.svn.wordpress.org/trunk@26353


git-svn-id: http://core.svn.wordpress.org/trunk@26254 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-11-24 14:59:10 +00:00
Andrew Nacin d0cfa40983 Add jshintrc to qunit.
props jorbin.
see #25187.

Built from https://develop.svn.wordpress.org/trunk@25992


git-svn-id: http://core.svn.wordpress.org/trunk@25925 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-10-30 14:39:10 +00:00
Drew Jaynes 15fb059069 Inline documentation for the Walker_Comment class in wp-includes/comment-template.php
Fixes #25388.

Built from https://develop.svn.wordpress.org/trunk@25588


git-svn-id: http://core.svn.wordpress.org/trunk@25505 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-09-23 23:29:11 +00:00
Drew Jaynes 681b1c35b5 Inline documentation for hooks in wp-includes/comment-template.php.
Fixes #25396.

Built from https://develop.svn.wordpress.org/trunk@25584


git-svn-id: http://core.svn.wordpress.org/trunk@25501 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-09-23 21:21:09 +00:00
Drew Jaynes 731db6bcb5 Inline documentation for `comment_form()` argument defaults missed in [25573].
See #25388.

Built from https://develop.svn.wordpress.org/trunk@25575


git-svn-id: http://core.svn.wordpress.org/trunk@25492 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-09-23 17:30:08 +00:00
Drew Jaynes fe40604971 Improve inline documentation of arguments for `comment_form()`.
See #25388.

Built from https://develop.svn.wordpress.org/trunk@25573


git-svn-id: http://core.svn.wordpress.org/trunk@25490 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-09-23 17:16:08 +00:00
Drew Jaynes e4987beba3 Inline documentation improvements for wp-includes/comment-template.php.
Changes include:
- Existing phpdoc block improvements
- Inclusion of defaults for optional parameters
- Hash-notated argument arrays
- Removal of unnecessary or redundant tagging.

Also standardization of int|WP_Post function parameters.

These changes clear the way toward less redundancy for hook docs in a future ticket.

Still left: Fully documented arguments in `comment_form()` and a pass through Walker_Comment.

See #20495. See #25388.

Built from https://develop.svn.wordpress.org/trunk@25567


git-svn-id: http://core.svn.wordpress.org/trunk@25485 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-09-23 04:16:08 +00:00