Drew Jaynes a7ea95f53a Docs: Add documentation for $object_id, the optional second parameter in current_user_can() and WP_User::has_cap(), and the optional third parameter in map_meta_cap(). ...

This change introduces the vernacular of "meta" vs "primitive" capabilities to core docs, and providing examples for each inline and attempts to make it clear that `$object_id` is really only useful if the passed `$capability` is of the meta cap variety.

Props jliman for the initial patch.
Fixes #32694.

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


git-svn-id: http://core.svn.wordpress.org/trunk@34188 1a063a9b-81f0-0310-95a4-ce76da25c4cd

2015-09-16 07:36:32 +00:00

..

certificates

…

css

Update links to the user profile editing screen in the admin toolbar when the current logged in user has no role on the current site. Covers single site and Multisite and introduces tests.

2015-09-14 17:10:26 +00:00

fonts

Dashicons: Fix font ID in SVG file.

2015-07-23 10:03:24 +00:00

ID3

Update getID3 to 1.9.9

2015-06-28 00:17:25 +00:00

images

…

js

Passwords: Trigger a wp-check-valid-field event when the password field is filled with a password by generatePassword().

2015-09-14 10:39:27 +00:00

pomo

Deprecate php4 style constructors

2015-06-28 15:27:24 +00:00

SimplePie

…

Text

Deprecate php4 style constructors

2015-06-28 15:27:24 +00:00

theme-compat

After [33961], pass $comment to get_comment_date() where possible to avoid extra cache/db lookups.

2015-09-11 06:15:24 +00:00

widgets

After [33961], pass $comment to get_comment_link() where possible to avoid extra cache/db lookups.

2015-09-11 06:21:25 +00:00

admin-bar.php

Create a function, get_preview_post_link(), to DRY the logic for applying the 'preview_post_link' filter to a URL.

2015-09-15 04:15:25 +00:00

atomlib.php

Deprecate php4 style constructors

2015-06-28 15:27:24 +00:00

author-template.php

Pass the original $user_id variable to the filter in get_the_author_meta().

2015-05-25 13:06:25 +00:00

bookmark-template.php

Sanitize the class passed to wp_list_bookmarks() and allow passing an array.

2015-06-22 20:55:28 +00:00

bookmark.php

After [33843], update the location of some files in This filter is documented in docs

2015-09-08 22:17:26 +00:00

cache.php

Clarify wp-includes/cache.php docs with some more precise language.

2015-09-10 18:24:24 +00:00

canonical.php

Implement wp_login_url() and wp_registration_url() in places where wp-login.php is currently hard-coded.

2015-09-15 17:11:35 +00:00

capabilities-functions.php

Docs: Add documentation for $object_id, the optional second parameter in current_user_can() and WP_User::has_cap(), and the optional third parameter in map_meta_cap().

2015-09-16 07:36:32 +00:00

capabilities.php

Roles: move classes into their own file. capbilities.php loads the new files, so this is 100% BC if someone is loading capbilities.php directly. New files created using svn cp.

2015-08-26 04:58:21 +00:00

category-functions.php

Move Walker_Category and Walker_CategoryDropdown into their own files via svn cp. Remove them from category-template.php. Load them in category.php. svn cp category.php over to category-functions.php, which also loads now in category.php.

2015-09-14 03:10:24 +00:00

category-template.php

Move Walker_Category and Walker_CategoryDropdown into their own files via svn cp. Remove them from category-template.php. Load them in category.php. svn cp category.php over to category-functions.php, which also loads now in category.php.

2015-09-14 03:10:24 +00:00

category.php

Move Walker_Category and Walker_CategoryDropdown into their own files via svn cp. Remove them from category-template.php. Load them in category.php. svn cp category.php over to category-functions.php, which also loads now in category.php.

2015-09-14 03:10:24 +00:00

class-feed.php

After [32656], add @access annotations to methods that have no doc block in wp-includes/*.

2015-05-29 21:37:24 +00:00

class-http.php

Place the filter docblock for http_api_transports immediately above the filter.

2015-09-15 08:12:25 +00:00

class-IXR.php

Deprecate php4 style constructors

2015-06-28 15:27:24 +00:00

class-json.php

Deprecate php4 style constructors

2015-06-28 15:27:24 +00:00

class-oembed.php

Space out.

2015-08-31 21:25:21 +00:00

class-phpass.php

Deprecate php4 style constructors

2015-06-28 15:27:24 +00:00

class-phpmailer.php

Remove debug cruft from [33124].

2015-07-09 07:56:24 +00:00

class-pop3.php

Deprecate php4 style constructors

2015-06-28 15:27:24 +00:00

class-simplepie.php

…

class-smtp.php

Update PHPMailer to 5.2.10 from 5.2.7.

2015-07-08 17:16:25 +00:00

class-snoopy.php

After [33843], update the location of some files in This filter is documented in docs

2015-09-08 22:17:26 +00:00

class-walker-category-dropdown.php

Move Walker_Category and Walker_CategoryDropdown into their own files via svn cp. Remove them from category-template.php. Load them in category.php. svn cp category.php over to category-functions.php, which also loads now in category.php.

2015-09-14 03:10:24 +00:00

class-walker-category.php

Move Walker_Category and Walker_CategoryDropdown into their own files via svn cp. Remove them from category-template.php. Load them in category.php. svn cp category.php over to category-functions.php, which also loads now in category.php.

2015-09-14 03:10:24 +00:00

class-walker-comment.php

After [33961], pass $comment to get_comment_link() where possible to avoid extra cache/db lookups.

2015-09-11 06:21:25 +00:00

class-walker-page-dropdown.php

Move Walker_Page and Walker_PageDropdown into their own files via svn cp. Remove them from post-template.php. Load them in post.php.

2015-09-14 02:59:24 +00:00

class-walker-page.php

Move Walker_Page and Walker_PageDropdown into their own files via svn cp. Remove them from post-template.php. Load them in post.php.

2015-09-14 02:59:24 +00:00

class-wp-admin-bar.php

Toolbar: Disambiguate links to the dashboard vs. to the customizer.

2015-07-08 20:03:24 +00:00

class-wp-ajax-response.php

…

class-wp-comment-query.php

WP_Comment_Query: add comment__in to allowed values for $orderby.

2015-09-15 16:35:44 +00:00

class-wp-comment.php

Docs: Add complete file, class, property, and method documentation for the new WP_Comment class, introduced in [33891].

2015-09-03 19:58:24 +00:00

class-wp-customize-control.php

foreach is a statement, not a function.

2015-08-25 20:28:22 +00:00

class-wp-customize-manager.php

Revert [34013] and parts of [33970].

2015-09-12 20:03:24 +00:00

class-wp-customize-nav-menus.php

Customizer: Use existing decoupled strings in Menu Locations section. See [31941] and [31951].

2015-08-25 21:53:20 +00:00

class-wp-customize-panel.php

Customize: Remove redundant aria-label attributes.

2015-09-13 06:16:26 +00:00

class-wp-customize-section.php

Round 2 of: We should use ellipses … / … instead of three dots/periods ... e.g Loading… not Loading...

2015-09-09 04:39:25 +00:00

class-wp-customize-setting.php

Add Customizer docs.

2015-09-05 19:53:24 +00:00

class-wp-customize-widgets.php

Customizer: Use hash_equals() for widgets.

2015-08-04 04:51:50 +00:00

class-wp-editor.php

Revert [34013] and parts of [33970].

2015-09-12 20:03:24 +00:00

class-wp-embed.php

foreach is a statement, not a function.

2015-08-25 20:28:22 +00:00

class-wp-error.php

Use void instead of null where appropriate when pipe-delimiting @return types. If a @return only contains void, remove it.

2015-05-24 05:40:25 +00:00

class-wp-http-cookie.php

Docs: Add a missing file header to wp-includes/class-wp-http-cookie.php, introduced in [33748].

2015-09-03 03:19:21 +00:00

class-wp-http-curl.php

After [33843], update the location of some files in This filter is documented in docs

2015-09-08 22:17:26 +00:00

class-wp-http-encoding.php

Docs: Add a missing file header for wp-includes/class-wp-http-encoding.php, introduced in [33748].

2015-09-03 03:28:21 +00:00

class-wp-http-ixr-client.php

Docs: Update the hook doc summary for the wp_http_ixr_client_headers filter, introduced in [34164].

2015-09-15 16:16:43 +00:00

class-wp-http-proxy.php

Docs: Add a missing file header to wp-includes/class-wp-http-proxy.php, introduced in [33748].

2015-09-03 03:30:21 +00:00

class-wp-http-streams.php

Fix the case-sensitivity of some HTTP class usage.

2015-09-14 17:37:25 +00:00

class-wp-image-editor-gd.php

Replace @returns with @return in PHP docblocks.

2015-07-02 21:05:24 +00:00

class-wp-image-editor-imagick.php

Replace @returns with @return in PHP docblocks.

2015-07-02 21:05:24 +00:00

class-wp-image-editor.php

foreach is a statement, not a function.

2015-08-25 20:28:22 +00:00

class-wp-meta-query.php

Use stricter sanitization for meta query clause keys.

2015-09-12 21:06:24 +00:00

class-wp-network.php

Multisite: Implement the get_by_path method in WP_Network.

2015-09-13 23:40:24 +00:00

class-wp-post.php

Posts: move WP_Post into its own file. post.php loads the new files, so this is 100% BC if someone is loading post.php directly. New files created using svn cp.

2015-08-26 12:40:21 +00:00

class-wp-rewrite.php

Rewrite: move WP_Rewrite into its own file. rewrite.php loads the new files, so this is 100% BC if someone is loading rewrite.php directly. New files created using svn cp.

2015-08-26 04:42:20 +00:00

class-wp-role.php

Roles: move classes into their own file. capbilities.php loads the new files, so this is 100% BC if someone is loading capbilities.php directly. New files created using svn cp.

2015-08-26 04:58:21 +00:00

class-wp-roles.php

Ensure that role is not empty before adding it in add_role() function and methods.

2015-09-09 03:42:25 +00:00

class-wp-tax-query.php

Taxonomy: move WP_Tax_Query into its own file. taxonomy.php loads the new files, so this is 100% BC if someone is loading taxonomy.php directly. New files created using svn cp.

2015-08-26 12:49:21 +00:00

class-wp-theme.php

WP_Theme has an ad hoc property in WP_MS_Themes_List_Table, $update. This can be set to a default value on the class, as it's not obtained via __get().

2015-09-09 01:02:24 +00:00

class-wp-user-query.php

Docs: Add a missing file header for wp-includes/class-wp-user-query.php, introduced in [33749].

2015-09-04 01:26:25 +00:00

class-wp-user.php

Docs: Add documentation for $object_id, the optional second parameter in current_user_can() and WP_User::has_cap(), and the optional third parameter in map_meta_cap().

2015-09-16 07:36:32 +00:00

class-wp-walker.php

Docs: Add missing parameter and return descriptions for Walker::get_number_of_root_elements().

2015-09-14 15:33:27 +00:00

class-wp-widget-factory.php

Docs: Clarify the file header summary for class-wp-widget-factory.php, introduced in [33746].

2015-09-03 02:54:22 +00:00

class-wp-widget.php

Docs: Improve the file header for class-wp-widget.php to describe what the file contains.

2015-09-03 02:50:21 +00:00

class-wp-xmlrpc-server.php

XMLRPC: Don't allow private posts to be sticky.

2015-09-14 22:38:23 +00:00

class-wp.php

In WP::parse_request(), don't add query vars of non-viewable post types to WP::public_query_vars. In register_post_type(), don't add query vars of non-viewable post types to WP::public_query_vars.

2015-09-15 18:54:30 +00:00

class.wp-dependencies.php

foreach is a statement, not a function.

2015-08-25 20:28:22 +00:00

class.wp-scripts.php

After [32656], add @access annotations to methods that have no doc block in wp-includes/*.

2015-05-29 21:37:24 +00:00

class.wp-styles.php

Add a missing $html parameter variable in the hook docs for the style_loader_tag filter.

2015-07-13 21:03:24 +00:00

comment-functions.php

In _wp_ajax_delete_comment_response(), read the new 'all' prop returned by get_comment_count() via wp_count_comments() when setting $total. 'all' doesn't include spam in its count.

2015-09-15 01:47:25 +00:00

comment-template.php

Apply the new 'respond_link' filter in comments_popup_link() if $number is 0 before outputting the URL.

2015-09-15 20:46:35 +00:00

comment.php

Walker_Comment should be in its own file. Loaded now via wp-includes/comment.php, which makes it 100% BC.

2015-09-09 02:41:24 +00:00

compat.php

Add doc blocks to functions that are missing them.

2015-05-31 03:18:25 +00:00

cron.php

Document @return value for wp_unschedule_event().

2015-09-11 11:35:24 +00:00

date.php

Simplify the weeks-per-year calculation WP_Date_Query::validate_date_values().

2015-08-29 01:47:21 +00:00

default-constants.php

After [33698], wrap the time constants in a DocBlock template.

2015-08-25 21:21:21 +00:00

default-filters.php

Add the site icon meta tags to wp-login.php.

2015-09-14 18:02:24 +00:00

default-widgets.php

Move widget classes to their own files in wp-includes/widgets:

2015-09-01 13:49:21 +00:00

deprecated.php

Deprecate wp_get_http() - function isn't used anywhere (apart from itself).

2015-09-09 04:26:25 +00:00

feed-atom-comments.php

if is a statment, not a function.

2015-06-16 20:01:25 +00:00

feed-atom.php

…

feed-rdf.php

…

feed-rss2-comments.php

Feeds: Revert [32765] because of objections raised in #4575.

2015-07-15 19:58:24 +00:00

feed-rss2.php

Feeds: Revert [32765] because of objections raised in #4575.

2015-07-15 19:58:24 +00:00

feed-rss.php

Serve RSS feeds with the proper mime-type: application/rss+xml. The reason for hacking around browsers by using text/xml appears to no longer be relevant.

2015-05-09 06:39:24 +00:00

feed.php

Comments: comment_link() currently takes no arguments, yet get_comment_link() does. Allow comment_link() to optionally take the same arguments.

2015-09-12 03:16:23 +00:00

formatting.php

Fix a typo in wptexturize() and wp_replace_in_html_tags() comments.

2015-09-16 05:54:26 +00:00

functions.php

More comment functions can accept a full object instead of comment_ID to reduce cache/db lookups.

2015-09-14 21:40:24 +00:00

functions.wp-scripts.php

After [32596] and [32597], ensure that wp_scripts|styles() is called to ensure an instance is created of WP_Scripts|Styles() before calling ->do_items().

2015-06-12 16:54:24 +00:00

functions.wp-styles.php

After [32596] and [32597], ensure that wp_scripts|styles() is called to ensure an instance is created of WP_Scripts|Styles() before calling ->do_items().

2015-06-12 16:54:24 +00:00

general-template.php

Implement wp_login_url() and wp_registration_url() in places where wp-login.php is currently hard-coded.

2015-09-15 17:11:35 +00:00

http-functions.php

Docs: Clarify the file header summary for wp-includes/http-functions.php, introduced in [33748].

2015-09-03 03:37:20 +00:00

http.php

Docs: Add inline DocBlocks for the require_once() calls that now bring in top-level HTTP API functionality and HTTP API classes.

2015-09-03 04:36:30 +00:00

kses.php

Allow these CSS properties in KSES: min-height', 'max-height', 'min-width', 'max-width'

2015-08-25 21:46:20 +00:00

l10n.php

foreach is a statement, not a function.

2015-08-25 20:28:22 +00:00

link-template.php

Remove the ability to view the post listing screen and post editing screen for post types with show_ui set to false. It is unexpected and unintended behaviour that this is allowed.

2015-09-15 10:27:29 +00:00

load.php

Favicon: Do not specify a Content-Length: 0 header for our "empty" response to fail more gracefully on environments with extra whitespace on output.

2015-09-07 02:18:26 +00:00

locale.php

Use _x() instead of string hacks for weekday and month abbreviations.

2015-09-11 15:36:25 +00:00

media-template.php

After [34048], restore the else statement for h (height of video) in wp_underscore_video_template().

2015-09-11 18:30:26 +00:00

media.php

Don't ever use the guid value when retrieving URLs for media, use wp_get_attachment_url(). Use get_attached_file() for path to file.

2015-09-15 02:50:25 +00:00

meta-functions.php

After [33843], update the location of some files in This filter is documented in docs

2015-09-08 22:17:26 +00:00

meta.php

Meta: move WP_Meta_Query into its own file. meta.php loads the new files, so this is 100% BC if someone is loading meta.php directly. New files created using svn cp.

2015-08-26 13:02:21 +00:00

ms-blogs.php

Fix doc blocks for ms-*.php files.

2015-05-26 21:51:31 +00:00

ms-default-constants.php

Fix doc blocks for ms-*.php files.

2015-05-26 21:51:31 +00:00

ms-default-filters.php

Send multisite site/user signup emails via hooked functions.

2015-09-14 03:28:24 +00:00

ms-deprecated.php

Docs: Standardize @deprecated tag formatting and add missing summaries to deprecated functions in wp-includes/ms-deprecated.php.

2015-08-20 22:36:25 +00:00

ms-files.php

if is a statment, not a function.

2015-06-16 20:01:25 +00:00

ms-functions.php

Send multisite site/user signup emails via hooked functions.

2015-09-14 03:28:24 +00:00

ms-load.php

Multisite: Implement the get_by_path method in WP_Network.

2015-09-13 23:40:24 +00:00

ms-settings.php

Multisite: Implement the get_by_path method in WP_Network.

2015-09-13 23:40:24 +00:00

nav-menu-template.php

Avoid PHP notices in redirect_canonical() and _wp_menu_item_classes_by_context() if $_SERVER['HTTP_HOST'] is not set.

2015-08-28 03:31:20 +00:00

nav-menu.php

foreach is a statement, not a function.

2015-08-25 20:28:22 +00:00

option.php

Update the length limit in set_transient() docs after [34030].

2015-09-11 15:10:27 +00:00

pluggable-deprecated.php

Docs: Standardize @deprecated tag formatting for deprecated functions in wp-includes/pluggable-deprecated.php.

2015-08-20 22:15:25 +00:00

pluggable.php

Fire Action when mail exception is thrown.

2015-09-15 23:51:23 +00:00

plugin.php

foreach is a statement, not a function.

2015-08-25 20:28:22 +00:00

post-formats.php

foreach is a statement, not a function.

2015-08-25 20:28:22 +00:00

post-functions.php

In WP::parse_request(), don't add query vars of non-viewable post types to WP::public_query_vars. In register_post_type(), don't add query vars of non-viewable post types to WP::public_query_vars.

2015-09-15 18:54:30 +00:00

post-template.php

Allow wp_page_menu() to accept 'walker', 'before', and 'after' to allow custom markup.

2015-09-15 15:06:30 +00:00

post-thumbnail-template.php

Update post thumbnail functions to allow a WP_Post to be passed.

2015-09-15 03:46:25 +00:00

post.php

Move Walker_Page and Walker_PageDropdown into their own files via svn cp. Remove them from post-template.php. Load them in post.php.

2015-09-14 02:59:24 +00:00

query.php

Use stricter sanitization for meta query clause keys.

2015-09-12 21:06:24 +00:00

registration-functions.php

…

registration.php

…

revision.php

foreach is a statement, not a function.

2015-08-25 20:28:22 +00:00

rewrite-constants.php

Docs: Clarify the file header summary for wp-includes/rewrite-constants.php, introduced in [33751].

2015-09-04 01:52:24 +00:00

rewrite-functions.php

Rewrite: move WP_Rewrite into its own file. rewrite.php loads the new files, so this is 100% BC if someone is loading rewrite.php directly. New files created using svn cp.

2015-08-26 04:42:20 +00:00

rewrite.php

Rewrite: move WP_Rewrite into its own file. rewrite.php loads the new files, so this is 100% BC if someone is loading rewrite.php directly. New files created using svn cp.

2015-08-26 04:42:20 +00:00

rss-functions.php

…

rss.php

foreach is a statement, not a function.

2015-08-25 20:28:22 +00:00

script-loader.php

Revert [34013] and parts of [33970].

2015-09-12 20:03:24 +00:00

session.php

…

shortcodes.php

Shortcodes: don't allow unclosed HTML elements in attributes

2015-09-14 22:36:24 +00:00

taxonomy-functions.php

Omit the ORDER BY clause when updating object term cache.

2015-09-15 20:53:33 +00:00

taxonomy.php

Taxonomy: move WP_Tax_Query into its own file. taxonomy.php loads the new files, so this is 100% BC if someone is loading taxonomy.php directly. New files created using svn cp.

2015-08-26 12:49:21 +00:00

template-loader.php

Add singular.php to template hierarchy

2015-06-18 19:01:26 +00:00

template.php

Docs: Update the DocBlock descriptions for a variety of template functions to better reflect that the dynamic $type_template hook can be used to filter the template path.

2015-07-14 22:27:24 +00:00

theme.php

Flush rewrite rules upon theme switch

2015-09-10 23:50:24 +00:00

update.php

Add missing doc blocks to update.php:

2015-05-28 15:29:28 +00:00

user-functions.php

Improve validation of user_login and user_nicename length.

2015-09-15 22:14:26 +00:00

user.php

Docs: Clarify the file header summary for wp-includes/user.php, the top-level file for the core Users API.

2015-09-04 01:33:24 +00:00

vars.php

Introduce a new $is_edge global for the Microsoft Edge browser.

2015-09-05 22:33:23 +00:00

version.php

Docs: Add documentation for $object_id, the optional second parameter in current_user_can() and WP_User::has_cap(), and the optional third parameter in map_meta_cap().

2015-09-16 07:36:32 +00:00

widget-functions.php

After [33843], update the location of some files in This filter is documented in docs

2015-09-08 22:17:26 +00:00

widgets.php

Docs: Clarify the file header summary for wp-includes/widgets.php, the top-level file for the core Widgets API.

2015-09-03 03:14:20 +00:00

wlwmanifest.xml

…

wp-db.php

In wpdb::get_col_length(), the final return false is unreachable since the default switch case returns.

2015-09-09 00:48:26 +00:00

wp-diff.php

…