WordPress-C
/
WordPress
mirror of https://github.com/WordPress/WordPress.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Docs: Standardize filter docs in remaining wp-includes/* files to use third-person singular verbs per the inline documentation standards for PHP. 

See #36913.

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


git-svn-id: http://core.svn.wordpress.org/trunk@37486 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2016-05-22 18:50:28 +00:00
parent 558d5b371c
commit 9cb5247392
39 changed files with 104 additions and 104 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
wp-includes/admin-bar.php
View File

@ -32,7 +32,7 @@ function _wp_admin_bar_init() {
/* Instantiate the admin bar */ /* Instantiate the admin bar */
/** /**
* Filter the admin bar class to instantiate. * Filters the admin bar class to instantiate.
* *
* @since 3.1.0 * @since 3.1.0
* *
@ -921,7 +921,7 @@ function is_admin_bar_showing() {
} }
/** /**
* Filter whether to show the admin bar. * Filters whether to show the admin bar.
* *
* Returning false to this hook is the recommended way to hide the admin bar. * Returning false to this hook is the recommended way to hide the admin bar.
* The user's display preference is used for logged in users. * The user's display preference is used for logged in users.

2
wp-includes/bookmark.php
View File

@ -132,7 +132,7 @@ function get_bookmarks( $args = '' ) {
if ( is_array( $cache ) && isset( $cache[ $key ] ) ) { if ( is_array( $cache ) && isset( $cache[ $key ] ) ) {
$bookmarks = $cache[ $key ]; $bookmarks = $cache[ $key ];
/** /**
* Filter the returned list of bookmarks. * Filters the returned list of bookmarks.
* *
* The first time the hook is evaluated in this file, it returns the cached * The first time the hook is evaluated in this file, it returns the cached
* bookmarks list. The second evaluation returns a cached bookmarks list if the * bookmarks list. The second evaluation returns a cached bookmarks list if the

2
wp-includes/canonical.php
View File

@ -486,7 +486,7 @@ function redirect_canonical( $requested_url = null, $do_redirect = true ) {
} }
/** /**
* Filter the canonical redirect URL. * Filters the canonical redirect URL.
* *
* Returning false to this filter will cancel the redirect. * Returning false to this filter will cancel the redirect.
* *

4
wp-includes/capabilities.php
View File

@ -249,7 +249,7 @@ function map_meta_cap( $cap, $user_id ) {
if ( $meta_key && has_filter( "auth_post_meta_{$meta_key}" ) ) { if ( $meta_key && has_filter( "auth_post_meta_{$meta_key}" ) ) {
/** /**
* Filter whether the user is allowed to add post meta to a post. * Filters whether the user is allowed to add post meta to a post.
* *
* The dynamic portion of the hook name, `$meta_key`, refers to the * The dynamic portion of the hook name, `$meta_key`, refers to the
* meta key passed to map_meta_cap(). * meta key passed to map_meta_cap().
@ -390,7 +390,7 @@ function map_meta_cap( $cap, $user_id ) {
} }
/** /**
* Filter a user's capabilities depending on specific context and/or privilege. * Filters a user's capabilities depending on specific context and/or privilege.
* *
* @since 2.8.0 * @since 2.8.0
* *

4
wp-includes/category.php
View File

@ -30,7 +30,7 @@ function get_categories( $args = '' ) {
$taxonomy = $args['taxonomy']; $taxonomy = $args['taxonomy'];
/** /**
* Filter the taxonomy used to retrieve terms when calling get_categories(). * Filters the taxonomy used to retrieve terms when calling get_categories().
* *
* @since 2.7.0 * @since 2.7.0
* *
@ -271,7 +271,7 @@ function get_tags( $args = '' ) {
} }
/** /**
* Filter the array of term objects returned for the 'post_tag' taxonomy. * Filters the array of term objects returned for the 'post_tag' taxonomy.
* *
* @since 2.3.0 * @since 2.3.0
* *

4
wp-includes/class-IXR.php
View File

@ -249,7 +249,7 @@ class IXR_Message
$element_limit = 30000; $element_limit = 30000;
if ( function_exists( 'apply_filters' ) ) { if ( function_exists( 'apply_filters' ) ) {
/** /**
* Filter the number of elements to parse in an XML-RPC response. * Filters the number of elements to parse in an XML-RPC response.
* *
* @since 4.0.0 * @since 4.0.0
* *
@ -273,7 +273,7 @@ class IXR_Message
$chunk_size = 262144; $chunk_size = 262144;
/** /**
* Filter the chunk size that can be used to parse an XML-RPC reponse message. * Filters the chunk size that can be used to parse an XML-RPC reponse message.
* *
* @since 4.4.0 * @since 4.4.0
* *

2
wp-includes/class-feed.php
View File

@ -38,7 +38,7 @@ class WP_Feed_Cache_Transient {
$lifetime = $this->lifetime; $lifetime = $this->lifetime;
/** /**
* Filter the transient lifetime of the feed cache. * Filters the transient lifetime of the feed cache.
* *
* @since 2.8.0 * @since 2.8.0
* *

12
wp-includes/class-oembed.php
View File

@ -115,7 +115,7 @@ class WP_oEmbed {
self::$early_providers = array(); self::$early_providers = array();
/** /**
* Filter the list of whitelisted oEmbed providers. * Filters the list of whitelisted oEmbed providers.
* *
* Since WordPress 4.4, oEmbed discovery is enabled for all users and allows embedding of sanitized * Since WordPress 4.4, oEmbed discovery is enabled for all users and allows embedding of sanitized
* iframes. The providers in this list are whitelisted, meaning they are trusted and allowed to * iframes. The providers in this list are whitelisted, meaning they are trusted and allowed to
@ -321,7 +321,7 @@ class WP_oEmbed {
return false; return false;
/** /**
* Filter the HTML returned by the oEmbed provider. * Filters the HTML returned by the oEmbed provider.
* *
* @since 2.9.0 * @since 2.9.0
* *
@ -348,7 +348,7 @@ class WP_oEmbed {
); );
/** /**
* Filter oEmbed remote get arguments. * Filters oEmbed remote get arguments.
* *
* @since 4.0.0 * @since 4.0.0
* *
@ -364,7 +364,7 @@ class WP_oEmbed {
if ( $html = wp_remote_retrieve_body( $request ) ) { if ( $html = wp_remote_retrieve_body( $request ) ) {
/** /**
* Filter the link types that contain oEmbed provider URLs. * Filters the link types that contain oEmbed provider URLs.
* *
* @since 2.9.0 * @since 2.9.0
* *
@ -435,7 +435,7 @@ class WP_oEmbed {
$provider = add_query_arg( 'url', urlencode($url), $provider ); $provider = add_query_arg( 'url', urlencode($url), $provider );
/** /**
* Filter the oEmbed URL to be fetched. * Filters the oEmbed URL to be fetched.
* *
* @since 2.9.0 * @since 2.9.0
* *
@ -598,7 +598,7 @@ class WP_oEmbed {
} }
/** /**
* Filter the returned oEmbed HTML. * Filters the returned oEmbed HTML.
* *
* Use this filter to add support for custom data types, or to filter the result. * Use this filter to add support for custom data types, or to filter the result.
* *

4
wp-includes/class-walker-category.php
View File

@ -111,7 +111,7 @@ class Walker_Category extends Walker {
$link = '<a href="' . esc_url( get_term_link( $category ) ) . '" '; $link = '<a href="' . esc_url( get_term_link( $category ) ) . '" ';
if ( $args['use_desc_for_title'] && ! empty( $category->description ) ) { if ( $args['use_desc_for_title'] && ! empty( $category->description ) ) {
/** /**
* Filter the category description for display. * Filters the category description for display.
* *
* @since 1.2.0 * @since 1.2.0
* *
@ -189,7 +189,7 @@ class Walker_Category extends Walker {
} }
/** /**
* Filter the list of CSS classes to include with each category in the list. * Filters the list of CSS classes to include with each category in the list.
* *
* @since 4.2.0 * @since 4.2.0
* *

2
wp-includes/class-walker-page-dropdown.php
View File

@ -75,7 +75,7 @@ class Walker_PageDropdown extends Walker {
} }
/** /**
* Filter the page title when creating an HTML drop-down list of pages. * Filters the page title when creating an HTML drop-down list of pages.
* *
* @since 3.1.0 * @since 3.1.0
* *

2
wp-includes/class-walker-page.php
View File

@ -116,7 +116,7 @@ class Walker_Page extends Walker {
} }
/** /**
* Filter the list of CSS classes to include with each page item in the list. * Filters the list of CSS classes to include with each page item in the list.
* *
* @since 2.8.0 * @since 2.8.0
* *

12
wp-includes/class-wp.php
View File

@ -146,7 +146,7 @@ class WP {
global $wp_rewrite; global $wp_rewrite;
/** /**
* Filter whether to parse the request. * Filters whether to parse the request.
* *
* @since 3.5.0 * @since 3.5.0
* *
@ -281,7 +281,7 @@ class WP {
} }
/** /**
* Filter the query variables whitelist before processing. * Filters the query variables whitelist before processing.
* *
* Allows (publicly allowed) query vars to be added, removed, or changed prior * Allows (publicly allowed) query vars to be added, removed, or changed prior
* to executing the query. Needed to allow custom rewrite rules using your own arguments * to executing the query. Needed to allow custom rewrite rules using your own arguments
@ -368,7 +368,7 @@ class WP {
$this->query_vars['error'] = $error; $this->query_vars['error'] = $error;
/** /**
* Filter the array of parsed query variables. * Filters the array of parsed query variables.
* *
* @since 2.1.0 * @since 2.1.0
* *
@ -463,7 +463,7 @@ class WP {
} }
/** /**
* Filter the HTTP headers before they're sent to the browser. * Filters the HTTP headers before they're sent to the browser.
* *
* @since 2.8.0 * @since 2.8.0
* *
@ -532,7 +532,7 @@ class WP {
if ( has_filter( 'query_string' ) ) { // Don't bother filtering and parsing if no plugins are hooked in. if ( has_filter( 'query_string' ) ) { // Don't bother filtering and parsing if no plugins are hooked in.
/** /**
* Filter the query string before parsing. * Filters the query string before parsing.
* *
* @since 1.5.0 * @since 1.5.0
* @deprecated 2.1.0 Use 'query_vars' or 'request' filters instead. * @deprecated 2.1.0 Use 'query_vars' or 'request' filters instead.
@ -631,7 +631,7 @@ class WP {
global $wp_query; global $wp_query;
/** /**
* Filter whether to short-circuit default header status handling. * Filters whether to short-circuit default header status handling.
* *
* Returning a non-false value from the filter will short-circuit the handling * Returning a non-false value from the filter will short-circuit the handling
* and return early. * and return early.

6
wp-includes/class.wp-scripts.php
View File

@ -286,7 +286,7 @@ class WP_Scripts extends WP_Dependencies {
if ( $this->do_concat ) { if ( $this->do_concat ) {
/** /**
* Filter the script loader source. * Filters the script loader source.
* *
* @since 2.2.0 * @since 2.2.0
* *
@ -345,7 +345,7 @@ class WP_Scripts extends WP_Dependencies {
$tag = "{$cond_before}{$before_handle}<script type='text/javascript' src='$src'></script>\n{$after_handle}{$cond_after}"; $tag = "{$cond_before}{$before_handle}<script type='text/javascript' src='$src'></script>\n{$after_handle}{$cond_after}";
/** /**
* Filter the HTML script tag of an enqueued script. * Filters the HTML script tag of an enqueued script.
* *
* @since 4.1.0 * @since 4.1.0
* *
@ -502,7 +502,7 @@ class WP_Scripts extends WP_Dependencies {
$r = parent::all_deps( $handles, $recursion, $group ); $r = parent::all_deps( $handles, $recursion, $group );
if ( ! $recursion ) { if ( ! $recursion ) {
/** /**
* Filter the list of script dependencies left to print. * Filters the list of script dependencies left to print.
* *
* @since 2.3.0 * @since 2.3.0
* *

6
wp-includes/class.wp-styles.php
View File

@ -189,7 +189,7 @@ class WP_Styles extends WP_Dependencies {
$title = isset($obj->extra['title']) ? "title='" . esc_attr( $obj->extra['title'] ) . "'" : ''; $title = isset($obj->extra['title']) ? "title='" . esc_attr( $obj->extra['title'] ) . "'" : '';
/** /**
* Filter the HTML link tag of an enqueued style. * Filters the HTML link tag of an enqueued style.
* *
* @since 2.6.0 * @since 2.6.0
* @since 4.3.0 Introduced the `$href` parameter. * @since 4.3.0 Introduced the `$href` parameter.
@ -313,7 +313,7 @@ class WP_Styles extends WP_Dependencies {
$r = parent::all_deps( $handles, $recursion, $group ); $r = parent::all_deps( $handles, $recursion, $group );
if ( ! $recursion ) { if ( ! $recursion ) {
/** /**
* Filter the array of enqueued styles before processing for output. * Filters the array of enqueued styles before processing for output.
* *
* @since 2.6.0 * @since 2.6.0
* *
@ -344,7 +344,7 @@ class WP_Styles extends WP_Dependencies {
$src = add_query_arg('ver', $ver, $src); $src = add_query_arg('ver', $ver, $src);
/** /**
* Filter an enqueued style's fully-qualified URL. * Filters an enqueued style's fully-qualified URL.
* *
* @since 2.6.0 * @since 2.6.0
* *

6
wp-includes/cron.php
View File

@ -35,7 +35,7 @@ function wp_schedule_single_event( $timestamp, $hook, $args = array()) {
$crons = _get_cron_array(); $crons = _get_cron_array();
$event = (object) array( 'hook' => $hook, 'timestamp' => $timestamp, 'schedule' => false, 'args' => $args ); $event = (object) array( 'hook' => $hook, 'timestamp' => $timestamp, 'schedule' => false, 'args' => $args );
/** /**
* Filter a single event before it is scheduled. * Filters a single event before it is scheduled.
* *
* @since 3.1.0 * @since 3.1.0
* *
@ -295,7 +295,7 @@ function spawn_cron( $gmt_time = 0 ) {
set_transient( 'doing_cron', $doing_wp_cron ); set_transient( 'doing_cron', $doing_wp_cron );
/** /**
* Filter the cron request arguments. * Filters the cron request arguments.
* *
* @since 3.5.0 * @since 3.5.0
* @since 4.5.0 The `$doing_wp_cron` parameter was added. * @since 4.5.0 The `$doing_wp_cron` parameter was added.
@ -396,7 +396,7 @@ function wp_get_schedules() {
'daily' => array( 'interval' => DAY_IN_SECONDS, 'display' => __( 'Once Daily' ) ), 'daily' => array( 'interval' => DAY_IN_SECONDS, 'display' => __( 'Once Daily' ) ),
); );
/** /**
* Filter the non-default cron schedules. * Filters the non-default cron schedules.
* *
* @since 2.1.0 * @since 2.1.0
* *

2
wp-includes/customize/class-wp-customize-nav-menu-item-setting.php
View File

@ -404,7 +404,7 @@ class WP_Customize_Nav_Menu_Item_Setting extends WP_Customize_Setting {
} }
/** /**
* Filter the wp_get_nav_menu_items() result to supply the previewed menu items. * Filters the wp_get_nav_menu_items() result to supply the previewed menu items.
* *
* @since 4.3.0 * @since 4.3.0
* @access public * @access public

6
wp-includes/customize/class-wp-customize-nav-menu-setting.php
View File

@ -235,7 +235,7 @@ class WP_Customize_Nav_Menu_Setting extends WP_Customize_Setting {
} }
/** /**
* Filter the wp_get_nav_menus() result to ensure the inserted menu object is included, and the deleted one is removed. * Filters the wp_get_nav_menus() result to ensure the inserted menu object is included, and the deleted one is removed.
* *
* @since 4.3.0 * @since 4.3.0
* @access public * @access public
@ -324,7 +324,7 @@ class WP_Customize_Nav_Menu_Setting extends WP_Customize_Setting {
} }
/** /**
* Filter the wp_get_nav_menu_object() result to supply the previewed menu object. * Filters the wp_get_nav_menu_object() result to supply the previewed menu object.
* *
* Requesting a nav_menu object by anything but ID is not supported. * Requesting a nav_menu object by anything but ID is not supported.
* *
@ -375,7 +375,7 @@ class WP_Customize_Nav_Menu_Setting extends WP_Customize_Setting {
} }
/** /**
* Filter the nav_menu_options option to include this menu's auto_add preference. * Filters the nav_menu_options option to include this menu's auto_add preference.
* *
* @since 4.3.0 * @since 4.3.0
* @access public * @access public

4
wp-includes/date.php
View File

@ -497,7 +497,7 @@ class WP_Date_Query {
// Attempt to detect a table prefix. // Attempt to detect a table prefix.
if ( false === strpos( $column, '.' ) ) { if ( false === strpos( $column, '.' ) ) {
/** /**
* Filter the list of valid date query columns. * Filters the list of valid date query columns.
* *
* @since 3.7.0 * @since 3.7.0
* @since 4.1.0 Added 'user_registered' to the default recognized columns. * @since 4.1.0 Added 'user_registered' to the default recognized columns.
@ -559,7 +559,7 @@ class WP_Date_Query {
$where = $sql['where']; $where = $sql['where'];
/** /**
* Filter the date query WHERE clause. * Filters the date query WHERE clause.
* *
* @since 3.7.0 * @since 3.7.0
* *

4
wp-includes/deprecated.php
View File

@ -3538,7 +3538,7 @@ function wp_richedit_pre($text) {
if ( empty( $text ) ) { if ( empty( $text ) ) {
/** /**
* Filter text returned for the rich text editor. * Filters text returned for the rich text editor.
* *
* This filter is first evaluated, and the value returned, if an empty string * This filter is first evaluated, and the value returned, if an empty string
* is passed to wp_richedit_pre(). If an empty string is passed, it results * is passed to wp_richedit_pre(). If an empty string is passed, it results
@ -3583,7 +3583,7 @@ function wp_htmledit_pre($output) {
$output = htmlspecialchars($output, ENT_NOQUOTES, get_option( 'blog_charset' ) ); // convert only < > & $output = htmlspecialchars($output, ENT_NOQUOTES, get_option( 'blog_charset' ) ); // convert only < > &
/** /**
* Filter the text before it is formatted for the HTML editor. * Filters the text before it is formatted for the HTML editor.
* *
* @since 2.5.0 * @since 2.5.0
* @deprecated 4.3.0 * @deprecated 4.3.0

4
wp-includes/feed-rss2.php
View File

@ -48,7 +48,7 @@ do_action( 'rss_tag_pre', 'rss2' );
$duration = 'hourly'; $duration = 'hourly';
/** /**
* Filter how often to update the RSS feed. * Filters how often to update the RSS feed.
* *
* @since 2.1.0 * @since 2.1.0
* *
@ -61,7 +61,7 @@ do_action( 'rss_tag_pre', 'rss2' );
$frequency = '1'; $frequency = '1';
/** /**
* Filter the RSS update frequency. * Filters the RSS update frequency.
* *
* @since 2.1.0 * @since 2.1.0
* *

6
wp-includes/kses.php
View File

@ -626,7 +626,7 @@ function wp_kses_allowed_html( $context = '' ) {
if ( is_array( $context ) ) { if ( is_array( $context ) ) {
/** /**
* Filter HTML elements allowed for a given context. * Filters HTML elements allowed for a given context.
* *
* @since 3.5.0 * @since 3.5.0
* *
@ -679,7 +679,7 @@ function wp_kses_allowed_html( $context = '' ) {
*/ */
function wp_kses_hook( $string, $allowed_html, $allowed_protocols ) { function wp_kses_hook( $string, $allowed_html, $allowed_protocols ) {
/** /**
* Filter content to be run through kses. * Filters content to be run through kses.
* *
* @since 2.3.0 * @since 2.3.0
* *
@ -1704,7 +1704,7 @@ function safecss_filter_attr( $css, $deprecated = '' ) {
$css_array = explode( ';', trim( $css ) ); $css_array = explode( ';', trim( $css ) );
/** /**
* Filter list of allowed CSS attributes. * Filters list of allowed CSS attributes.
* *
* @since 2.8.1 * @since 2.8.1
* *

12
wp-includes/meta.php
View File

@ -52,7 +52,7 @@ function add_metadata($meta_type, $object_id, $meta_key, $meta_value, $unique =
$meta_value = sanitize_meta( $meta_key, $meta_value, $meta_type ); $meta_value = sanitize_meta( $meta_key, $meta_value, $meta_type );
/** /**
* Filter whether to add metadata of a specific type. * Filters whether to add metadata of a specific type.
* *
* The dynamic portion of the hook, `$meta_type`, refers to the meta * The dynamic portion of the hook, `$meta_type`, refers to the meta
* object type (comment, post, or user). Returning a non-null value * object type (comment, post, or user). Returning a non-null value
@ -168,7 +168,7 @@ function update_metadata($meta_type, $object_id, $meta_key, $meta_value, $prev_v
$meta_value = sanitize_meta( $meta_key, $meta_value, $meta_type ); $meta_value = sanitize_meta( $meta_key, $meta_value, $meta_type );
/** /**
* Filter whether to update metadata of a specific type. * Filters whether to update metadata of a specific type.
* *
* The dynamic portion of the hook, `$meta_type`, refers to the meta * The dynamic portion of the hook, `$meta_type`, refers to the meta
* object type (comment, post, or user). Returning a non-null value * object type (comment, post, or user). Returning a non-null value
@ -328,7 +328,7 @@ function delete_metadata($meta_type, $object_id, $meta_key, $meta_value = '', $d
$meta_value = wp_unslash($meta_value); $meta_value = wp_unslash($meta_value);
/** /**
* Filter whether to delete metadata of a specific type. * Filters whether to delete metadata of a specific type.
* *
* The dynamic portion of the hook, `$meta_type`, refers to the meta * The dynamic portion of the hook, `$meta_type`, refers to the meta
* object type (comment, post, or user). Returning a non-null value * object type (comment, post, or user). Returning a non-null value
@ -469,7 +469,7 @@ function get_metadata($meta_type, $object_id, $meta_key = '', $single = false) {
} }
/** /**
* Filter whether to retrieve metadata of a specific type. * Filters whether to retrieve metadata of a specific type.
* *
* The dynamic portion of the hook, `$meta_type`, refers to the meta * The dynamic portion of the hook, `$meta_type`, refers to the meta
* object type (comment, post, or user). Returning a non-null value * object type (comment, post, or user). Returning a non-null value
@ -921,7 +921,7 @@ function is_protected_meta( $meta_key, $meta_type = null ) {
$protected = ( '_' == $meta_key[0] ); $protected = ( '_' == $meta_key[0] );
/** /**
* Filter whether a meta key is protected. * Filters whether a meta key is protected.
* *
* @since 3.2.0 * @since 3.2.0
* *
@ -945,7 +945,7 @@ function is_protected_meta( $meta_key, $meta_type = null ) {
function sanitize_meta( $meta_key, $meta_value, $meta_type ) { function sanitize_meta( $meta_key, $meta_value, $meta_type ) {
/** /**
* Filter the sanitization of a specific meta key of a specific meta type. * Filters the sanitization of a specific meta key of a specific meta type.
* *
* The dynamic portions of the hook name, `$meta_type`, and `$meta_key`, * The dynamic portions of the hook name, `$meta_type`, and `$meta_key`,
* refer to the metadata object type (comment, post, or user) and the meta * refer to the metadata object type (comment, post, or user) and the meta

4
wp-includes/ms-blogs.php
View File

@ -235,7 +235,7 @@ function get_blog_details( $fields = null, $get_all = true ) {
restore_current_blog(); restore_current_blog();
/** /**
* Filter a blog's details. * Filters a blog's details.
* *
* @since MU * @since MU
* *
@ -591,7 +591,7 @@ function get_blog_option( $id, $option, $default = false ) {
restore_current_blog(); restore_current_blog();
/** /**
* Filter a blog option value. * Filters a blog option value.
* *
* The dynamic portion of the hook name, `$option`, refers to the blog option name. * The dynamic portion of the hook name, `$option`, refers to the blog option name.
* *

4
wp-includes/ms-load.php
View File

@ -71,7 +71,7 @@ function ms_site_check() {
$blog = get_blog_details(); $blog = get_blog_details();
/** /**
* Filter checking the status of the current blog. * Filters checking the status of the current blog.
* *
* @since 3.0.0 * @since 3.0.0
* *
@ -168,7 +168,7 @@ function get_site_by_path( $domain, $path, $segments = null ) {
$path_segments = array_filter( explode( '/', trim( $path, '/' ) ) ); $path_segments = array_filter( explode( '/', trim( $path, '/' ) ) );
/** /**
* Filter the number of path segments to consider when searching for a site. * Filters the number of path segments to consider when searching for a site.
* *
* @since 3.9.0 * @since 3.9.0
* *

14
wp-includes/nav-menu.php
View File

@ -39,7 +39,7 @@ function wp_get_nav_menu_object( $menu ) {
} }
/** /**
* Filter the nav_menu term retrieved for wp_get_nav_menu_object(). * Filters the nav_menu term retrieved for wp_get_nav_menu_object().
* *
* @since 4.3.0 * @since 4.3.0
* *
@ -171,7 +171,7 @@ function has_nav_menu( $location ) {
} }
/** /**
* Filter whether a nav menu is assigned to the specified location. * Filters whether a nav menu is assigned to the specified location.
* *
* @since 4.3.0 * @since 4.3.0
* *
@ -543,7 +543,7 @@ function wp_get_nav_menus( $args = array() ) {
$args = wp_parse_args( $args, $defaults ); $args = wp_parse_args( $args, $defaults );
/** /**
* Filter the navigation menu objects being returned. * Filters the navigation menu objects being returned.
* *
* @since 3.0.0 * @since 3.0.0
* *
@ -689,7 +689,7 @@ function wp_get_nav_menu_items( $menu, $args = array() ) {
} }
/** /**
* Filter the navigation menu items being returned. * Filters the navigation menu items being returned.
* *
* @since 3.0.0 * @since 3.0.0
* *
@ -798,7 +798,7 @@ function wp_setup_nav_menu_item( $menu_item ) {
$menu_item->target = ! isset( $menu_item->target ) ? get_post_meta( $menu_item->ID, '_menu_item_target', true ) : $menu_item->target; $menu_item->target = ! isset( $menu_item->target ) ? get_post_meta( $menu_item->ID, '_menu_item_target', true ) : $menu_item->target;
/** /**
* Filter a navigation menu item's title attribute. * Filters a navigation menu item's title attribute.
* *
* @since 3.0.0 * @since 3.0.0
* *
@ -808,7 +808,7 @@ function wp_setup_nav_menu_item( $menu_item ) {
if ( ! isset( $menu_item->description ) ) { if ( ! isset( $menu_item->description ) ) {
/** /**
* Filter a navigation menu item's description. * Filters a navigation menu item's description.
* *
* @since 3.0.0 * @since 3.0.0
* *
@ -869,7 +869,7 @@ function wp_setup_nav_menu_item( $menu_item ) {
} }
/** /**
* Filter a navigation menu item object. * Filters a navigation menu item object.
* *
* @since 3.0.0 * @since 3.0.0
* *

6
wp-includes/rest-api.php
View File

@ -159,7 +159,7 @@ function rest_api_loaded() {
*/ */
function rest_get_url_prefix() { function rest_get_url_prefix() {
/** /**
* Filter the REST URL prefix. * Filters the REST URL prefix.
* *
* @since 4.4.0 * @since 4.4.0
* *
@ -206,7 +206,7 @@ function get_rest_url( $blog_id = null, $path = '/', $scheme = 'rest' ) {
} }
/** /**
* Filter the REST URL. * Filters the REST URL.
* *
* Use this filter to adjust the url returned by the `get_rest_url` function. * Use this filter to adjust the url returned by the `get_rest_url` function.
* *
@ -269,7 +269,7 @@ function rest_get_server() {
if ( empty( $wp_rest_server ) ) { if ( empty( $wp_rest_server ) ) {
/** /**
* Filter the REST Server Class. * Filters the REST Server Class.
* *
* This filter allows you to adjust the server class used by the API, using a * This filter allows you to adjust the server class used by the API, using a
* different class to handle requests. * different class to handle requests.

8
wp-includes/revision.php
View File

@ -38,7 +38,7 @@ function _wp_post_revision_fields( $post = array(), $deprecated = false ) {
} }
/** /**
* Filter the list of fields saved in post revisions. * Filters the list of fields saved in post revisions.
* *
* Included by default: 'post_title', 'post_content' and 'post_excerpt'. * Included by default: 'post_title', 'post_content' and 'post_excerpt'.
* *
@ -138,7 +138,7 @@ function wp_save_post_revision( $post_id ) {
} }
/** /**
* Filter whether the post has changed since the last revision. * Filters whether the post has changed since the last revision.
* *
* By default a revision is saved only if one of the revisioned fields has changed. * By default a revision is saved only if one of the revisioned fields has changed.
* This filter can override that so a revision is saved even if nothing has changed. * This filter can override that so a revision is saved even if nothing has changed.
@ -162,7 +162,7 @@ function wp_save_post_revision( $post_id ) {
} }
/** /**
* Filter whether a post has changed. * Filters whether a post has changed.
* *
* By default a revision is saved only if one of the revisioned fields has changed. * By default a revision is saved only if one of the revisioned fields has changed.
* This filter allows for additional checks to determine if there were changes. * This filter allows for additional checks to determine if there were changes.
@ -500,7 +500,7 @@ function wp_revisions_to_keep( $post ) {
$num = 0; $num = 0;
/** /**
* Filter the number of revisions to save for the given post. * Filters the number of revisions to save for the given post.
* *
* Overrides the value of WP_POST_REVISIONS. * Overrides the value of WP_POST_REVISIONS.
* *

4
wp-includes/rewrite.php
View File

@ -311,7 +311,7 @@ function add_rewrite_endpoint( $name, $places, $query_var = true ) {
} }
/** /**
* Filter the URL base for taxonomies. * Filters the URL base for taxonomies.
* *
* To remove any manually prepended /index.php/. * To remove any manually prepended /index.php/.
* *
@ -463,7 +463,7 @@ function url_to_postid( $url ) {
global $wp_rewrite; global $wp_rewrite;
/** /**
* Filter the URL to derive the post ID from. * Filters the URL to derive the post ID from.
* *
* @since 2.2.0 * @since 2.2.0
* *

14
wp-includes/script-loader.php
View File

@ -138,7 +138,7 @@ function wp_default_scripts( &$scripts ) {
$scripts->add( 'heartbeat', "/wp-includes/js/heartbeat$suffix.js", array('jquery'), false, 1 ); $scripts->add( 'heartbeat', "/wp-includes/js/heartbeat$suffix.js", array('jquery'), false, 1 );
did_action( 'init' ) && $scripts->localize( 'heartbeat', 'heartbeatSettings', did_action( 'init' ) && $scripts->localize( 'heartbeat', 'heartbeatSettings',
/** /**
* Filter the Heartbeat settings. * Filters the Heartbeat settings.
* *
* @since 3.6.0 * @since 3.6.0
* *
@ -152,7 +152,7 @@ function wp_default_scripts( &$scripts ) {
'beforeunload' => __('Your session has expired. You can log in again from this page or go to the login page.'), 'beforeunload' => __('Your session has expired. You can log in again from this page or go to the login page.'),
/** /**
* Filter the authentication check interval. * Filters the authentication check interval.
* *
* @since 3.6.0 * @since 3.6.0
* *
@ -360,7 +360,7 @@ function wp_default_scripts( &$scripts ) {
); );
did_action( 'init' ) && $scripts->localize( 'mediaelement', '_wpmejsSettings', did_action( 'init' ) && $scripts->localize( 'mediaelement', '_wpmejsSettings',
/** /**
* Filter the MediaElement configuration settings. * Filters the MediaElement configuration settings.
* *
* @since 4.4.0 * @since 4.4.0
* *
@ -927,7 +927,7 @@ function print_head_scripts() {
$wp_scripts->do_head_items(); $wp_scripts->do_head_items();
/** /**
* Filter whether to print the head scripts. * Filters whether to print the head scripts.
* *
* @since 2.8.0 * @since 2.8.0
* *
@ -962,7 +962,7 @@ function print_footer_scripts() {
$wp_scripts->do_footer_items(); $wp_scripts->do_footer_items();
/** /**
* Filter whether to print the footer scripts. * Filters whether to print the footer scripts.
* *
* @since 2.8.0 * @since 2.8.0
* *
@ -1098,7 +1098,7 @@ function print_admin_styles() {
$wp_styles->do_items(false); $wp_styles->do_items(false);
/** /**
* Filter whether to print the admin styles. * Filters whether to print the admin styles.
* *
* @since 2.8.0 * @since 2.8.0
* *
@ -1134,7 +1134,7 @@ function print_late_styles() {
$wp_styles->do_footer_items(); $wp_styles->do_footer_items();
/** /**
* Filter whether to print the styles queued too late for the HTML head. * Filters whether to print the styles queued too late for the HTML head.
* *
* @since 3.3.0 * @since 3.3.0
* *

4
wp-includes/session.php
View File

@ -40,7 +40,7 @@ abstract class WP_Session_Tokens {
*/ */
final public static function get_instance( $user_id ) { final public static function get_instance( $user_id ) {
/** /**
* Filter the session token manager used. * Filters the session token manager used.
* *
* @since 4.0.0 * @since 4.0.0
* *
@ -118,7 +118,7 @@ abstract class WP_Session_Tokens {
*/ */
final public function create( $expiration ) { final public function create( $expiration ) {
/** /**
* Filter the information attached to the newly created session. * Filters the information attached to the newly created session.
* *
* Could be used in the future to attach information such as * Could be used in the future to attach information such as
* IP address or user agent to a session. * IP address or user agent to a session.

2
wp-includes/shortcodes.php
View File

@ -537,7 +537,7 @@ function shortcode_atts( $pairs, $atts, $shortcode = '' ) {
$out[$name] = $default; $out[$name] = $default;
} }
/** /**
* Filter a shortcode's default attributes. * Filters a shortcode's default attributes.
* *
* If the third parameter of the shortcode_atts() function is present then this filter is available. * If the third parameter of the shortcode_atts() function is present then this filter is available.
* The third parameter, $shortcode, is the name of the shortcode. * The third parameter, $shortcode, is the name of the shortcode.

4
wp-includes/template-loader.php
View File

@ -12,7 +12,7 @@ if ( defined('WP_USE_THEMES') && WP_USE_THEMES )
do_action( 'template_redirect' ); do_action( 'template_redirect' );
/** /**
* Filter whether to allow 'HEAD' requests to generate content. * Filters whether to allow 'HEAD' requests to generate content.
* *
* Provides a significant performance bump by exiting before the page * Provides a significant performance bump by exiting before the page
* content loads for 'HEAD' requests. See #14348. * content loads for 'HEAD' requests. See #14348.
@ -65,7 +65,7 @@ if ( defined('WP_USE_THEMES') && WP_USE_THEMES ) :
$template = get_index_template(); $template = get_index_template();
endif; endif;
/** /**
* Filter the path of the current template before including it. * Filters the path of the current template before including it.
* *
* @since 3.0.0 * @since 3.0.0
* *

2
wp-includes/template.php
View File

@ -29,7 +29,7 @@ function get_query_template( $type, $templates = array() ) {
$template = locate_template( $templates ); $template = locate_template( $templates );
/** /**
* Filter the path of the queried template by type. * Filters the path of the queried template by type.
* *
* The dynamic portion of the hook name, `$type`, refers to the filename -- minus the file * The dynamic portion of the hook name, `$type`, refers to the filename -- minus the file
* extension and any non-alphanumeric characters delimiting words -- of the file to load. * extension and any non-alphanumeric characters delimiting words -- of the file to load.

4
wp-includes/theme-compat/embed-content.php
View File

@ -38,7 +38,7 @@
} }
/** /**
* Filter the thumbnail image size for use in the embed template. * Filters the thumbnail image size for use in the embed template.
* *
* @since 4.4.0 * @since 4.4.0
* @since 4.5.0 Added `$thumbnail_id` parameter. * @since 4.5.0 Added `$thumbnail_id` parameter.
@ -51,7 +51,7 @@
$shape = $measurements[0] / $measurements[1] >= 1.75 ? 'rectangular' : 'square'; $shape = $measurements[0] / $measurements[1] >= 1.75 ? 'rectangular' : 'square';
/** /**
* Filter the thumbnail shape for use in the embed template. * Filters the thumbnail shape for use in the embed template.
* *
* Rectangular images are shown above the title while square images * Rectangular images are shown above the title while square images
* are shown next to the content. * are shown next to the content.

8
wp-includes/update.php
View File

@ -55,7 +55,7 @@ function wp_version_check( $extra_stats = array(), $force_check = false ) {
} }
/** /**
* Filter the locale requested for WordPress core translations. * Filters the locale requested for WordPress core translations.
* *
* @since 2.8.0 * @since 2.8.0
* *
@ -265,7 +265,7 @@ function wp_update_plugins( $extra_stats = array() ) {
$locales = array_values( get_available_languages() ); $locales = array_values( get_available_languages() );
/** /**
* Filter the locales requested for plugin translations. * Filters the locales requested for plugin translations.
* *
* @since 3.7.0 * @since 3.7.0
* @since 4.5.0 The default value of the `$locales` parameter changed to include all locales. * @since 4.5.0 The default value of the `$locales` parameter changed to include all locales.
@ -439,7 +439,7 @@ function wp_update_themes( $extra_stats = array() ) {
$locales = array_values( get_available_languages() ); $locales = array_values( get_available_languages() );
/** /**
* Filter the locales requested for theme translations. * Filters the locales requested for theme translations.
* *
* @since 3.7.0 * @since 3.7.0
* @since 4.5.0 The default value of the `$locales` parameter changed to include all locales. * @since 4.5.0 The default value of the `$locales` parameter changed to include all locales.
@ -579,7 +579,7 @@ function wp_get_update_data() {
$update_data = array( 'counts' => $counts, 'title' => $update_title ); $update_data = array( 'counts' => $counts, 'title' => $update_title );
/** /**
* Filter the returned array of update data for plugins, themes, and WordPress core. * Filters the returned array of update data for plugins, themes, and WordPress core.
* *
* @since 3.5.0 * @since 3.5.0
* *

2
wp-includes/vars.php
View File

@ -59,7 +59,7 @@ if ( isset($_SERVER['HTTP_USER_AGENT']) ) {
if ( stripos( $_SERVER['HTTP_USER_AGENT'], 'chromeframe' ) !== false ) { if ( stripos( $_SERVER['HTTP_USER_AGENT'], 'chromeframe' ) !== false ) {
$is_admin = is_admin(); $is_admin = is_admin();
/** /**
* Filter whether Google Chrome Frame should be used, if available. * Filters whether Google Chrome Frame should be used, if available.
* *
* @since 3.2.0 * @since 3.2.0
* *

2
wp-includes/version.php
View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.6-alpha-37517'; $wp_version = '4.6-alpha-37518';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.

8
wp-includes/widgets.php
View File

@ -672,7 +672,7 @@ function dynamic_sidebar( $index = 1 ) {
$params[0]['before_widget'] = sprintf($params[0]['before_widget'], $id, $classname_); $params[0]['before_widget'] = sprintf($params[0]['before_widget'], $id, $classname_);
/** /**
* Filter the parameters passed to a widget's display callback. * Filters the parameters passed to a widget's display callback.
* *
* Note: The filter is evaluated on both the front end and back end, * Note: The filter is evaluated on both the front end and back end,
* including for the Inactive Widgets sidebar on the Widgets screen. * including for the Inactive Widgets sidebar on the Widgets screen.
@ -755,7 +755,7 @@ function dynamic_sidebar( $index = 1 ) {
do_action( 'dynamic_sidebar_after', $index, true ); do_action( 'dynamic_sidebar_after', $index, true );
/** /**
* Filter whether a sidebar has widgets. * Filters whether a sidebar has widgets.
* *
* Note: The filter is also evaluated for empty sidebars, and on both the front end * Note: The filter is also evaluated for empty sidebars, and on both the front end
* and back end, including the Inactive Widgets sidebar on the Widgets screen. * and back end, including the Inactive Widgets sidebar on the Widgets screen.
@ -853,7 +853,7 @@ function is_active_sidebar( $index ) {
$is_active_sidebar = ! empty( $sidebars_widgets[$index] ); $is_active_sidebar = ! empty( $sidebars_widgets[$index] );
/** /**
* Filter whether a dynamic sidebar is considered "active". * Filters whether a dynamic sidebar is considered "active".
* *
* @since 3.9.0 * @since 3.9.0
* *
@ -904,7 +904,7 @@ function wp_get_sidebars_widgets( $deprecated = true ) {
unset($sidebars_widgets['array_version']); unset($sidebars_widgets['array_version']);
/** /**
* Filter the list of sidebars and their widgets. * Filters the list of sidebars and their widgets.
* *
* @since 2.7.0 * @since 2.7.0
* *

8
wp-includes/wp-db.php
View File

@ -839,7 +839,7 @@ class wpdb {
$modes = array_change_key_case( $modes, CASE_UPPER ); $modes = array_change_key_case( $modes, CASE_UPPER );
/** /**
* Filter the list of incompatible SQL modes to exclude. * Filters the list of incompatible SQL modes to exclude.
* *
* @since 3.9.0 * @since 3.9.0
* *
@ -1679,7 +1679,7 @@ class wpdb {
} }
/** /**
* Filter the database query. * Filters the database query.
* *
* Some queries are made before the plugins have been loaded, * Some queries are made before the plugins have been loaded,
* and thus cannot be filtered with this method. * and thus cannot be filtered with this method.
@ -2372,7 +2372,7 @@ class wpdb {
$tablekey = strtolower( $table ); $tablekey = strtolower( $table );
/** /**
* Filter the table charset value before the DB is checked. * Filters the table charset value before the DB is checked.
* *
* Passing a non-null value to the filter will effectively short-circuit * Passing a non-null value to the filter will effectively short-circuit
* checking the DB for the charset, returning that value instead. * checking the DB for the charset, returning that value instead.
@ -2476,7 +2476,7 @@ class wpdb {
$columnkey = strtolower( $column ); $columnkey = strtolower( $column );
/** /**
* Filter the column charset value before the DB is checked. * Filters the column charset value before the DB is checked.
* *
* Passing a non-null value to the filter will short-circuit * Passing a non-null value to the filter will short-circuit
* checking the DB for the charset, returning that value instead. * checking the DB for the charset, returning that value instead.