Docs: Consistently use third-person singular verbs for various filter descriptions, per the documentation standards.

See #50768.

git-svn-id: https://develop.svn.wordpress.org/trunk@48782 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Sergey Biryukov 2020-08-11 00:32:22 +00:00
parent 635ae16e85
commit a84a5029be
66 changed files with 92 additions and 90 deletions

View File

@ -626,7 +626,7 @@ class WP_MS_Sites_List_Table extends WP_List_Table {
} }
/** /**
* Filter the default site display states for items in the Sites list table. * Filters the default site display states for items in the Sites list table.
* *
* @since 5.3.0 * @since 5.3.0
* *

View File

@ -152,7 +152,7 @@ class WP_Site_Health {
*/ */
private function perform_test( $callback ) { private function perform_test( $callback ) {
/** /**
* Filter the output of a finished Site Health test. * Filters the output of a finished Site Health test.
* *
* @since 5.3.0 * @since 5.3.0
* *

View File

@ -1125,7 +1125,7 @@ function download_url( $url, $timeout = 300, $signature_verification = false ) {
} }
/** /**
* Filter the URL where the signature for a file is located. * Filters the URL where the signature for a file is located.
* *
* @since 5.2.0 * @since 5.2.0
* *
@ -1394,7 +1394,7 @@ function wp_trusted_keys() {
// TODO: Add key #2 with longer expiration. // TODO: Add key #2 with longer expiration.
/** /**
* Filter the valid signing keys used to verify the contents of files. * Filters the valid signing keys used to verify the contents of files.
* *
* @since 5.2.0 * @since 5.2.0
* *

View File

@ -2127,7 +2127,7 @@ function use_block_editor_for_post( $post ) {
$use_block_editor = use_block_editor_for_post_type( $post->post_type ); $use_block_editor = use_block_editor_for_post_type( $post->post_type );
/** /**
* Filter whether a post is able to be edited in the block editor. * Filters whether a post is able to be edited in the block editor.
* *
* @since 5.0.0 * @since 5.0.0
* *
@ -2163,7 +2163,7 @@ function use_block_editor_for_post_type( $post_type ) {
} }
/** /**
* Filter whether a post is able to be edited in the block editor. * Filters whether a post is able to be edited in the block editor.
* *
* @since 5.0.0 * @since 5.0.0
* *
@ -2216,7 +2216,7 @@ function get_block_categories( $post ) {
); );
/** /**
* Filter the default array of block categories. * Filters the default array of block categories.
* *
* @since 5.0.0 * @since 5.0.0
* *

View File

@ -53,7 +53,7 @@ get_header(); ?>
<div id="author-avatar"> <div id="author-avatar">
<?php <?php
/** /**
* Filter the Twenty Eleven author bio avatar size. * Filters the Twenty Eleven author bio avatar size.
* *
* @since Twenty Eleven 1.0 * @since Twenty Eleven 1.0
* *

View File

@ -26,7 +26,7 @@ get_header(); ?>
$category_description = category_description(); $category_description = category_description();
if ( ! empty( $category_description ) ) { if ( ! empty( $category_description ) ) {
/** /**
* Filter the default Twenty Eleven category description. * Filters the default Twenty Eleven category description.
* *
* @since Twenty Eleven 1.0 * @since Twenty Eleven 1.0
* *

View File

@ -35,7 +35,7 @@
<div class="avatar"> <div class="avatar">
<?php <?php
/** /**
* Filter the Twenty Eleven status avatar size. * Filters the Twenty Eleven status avatar size.
* *
* @since Twenty Eleven 1.0 * @since Twenty Eleven 1.0
* *

View File

@ -174,7 +174,7 @@ if ( ! function_exists( 'twentyeleven_setup' ) ) :
'default-text-color' => '000', 'default-text-color' => '000',
// The height and width of our custom header. // The height and width of our custom header.
/** /**
* Filter the Twenty Eleven default header image width. * Filters the Twenty Eleven default header image width.
* *
* @since Twenty Eleven 1.0 * @since Twenty Eleven 1.0
* *
@ -182,7 +182,7 @@ if ( ! function_exists( 'twentyeleven_setup' ) ) :
*/ */
'width' => apply_filters( 'twentyeleven_header_image_width', 1000 ), 'width' => apply_filters( 'twentyeleven_header_image_width', 1000 ),
/** /**
* Filter the Twenty Eleven default header image height. * Filters the Twenty Eleven default header image height.
* *
* @since Twenty Eleven 1.0 * @since Twenty Eleven 1.0
* *

View File

@ -93,7 +93,7 @@ get_header(); ?>
<a href="<?php echo esc_url( $next_attachment_url ); ?>" title="<?php the_title_attribute(); ?>" rel="attachment"> <a href="<?php echo esc_url( $next_attachment_url ); ?>" title="<?php the_title_attribute(); ?>" rel="attachment">
<?php <?php
/** /**
* Filter the Twenty Eleven default attachment size. * Filters the Twenty Eleven default attachment size.
* *
* @since Twenty Eleven 1.0 * @since Twenty Eleven 1.0
* *

View File

@ -162,7 +162,7 @@ function twentyeleven_color_schemes() {
); );
/** /**
* Filter the Twenty Eleven color scheme options. * Filters the Twenty Eleven color scheme options.
* *
* @since Twenty Eleven 1.0 * @since Twenty Eleven 1.0
* *
@ -196,7 +196,7 @@ function twentyeleven_layouts() {
); );
/** /**
* Filter the Twenty Eleven layout options. * Filters the Twenty Eleven layout options.
* *
* @since Twenty Eleven 1.0 * @since Twenty Eleven 1.0
* *
@ -224,7 +224,7 @@ function twentyeleven_get_default_theme_options() {
} }
/** /**
* Filter the Twenty Eleven default options. * Filters the Twenty Eleven default options.
* *
* @since Twenty Eleven 1.0 * @since Twenty Eleven 1.0
* *
@ -398,7 +398,7 @@ function twentyeleven_theme_options_validate( $input ) {
} }
/** /**
* Filter the Twenty Eleven sanitized form input array. * Filters the Twenty Eleven sanitized form input array.
* *
* @since Twenty Eleven 1.0 * @since Twenty Eleven 1.0
* *
@ -508,7 +508,7 @@ function twentyeleven_layout_classes( $existing_classes ) {
} }
/** /**
* Filter the Twenty Eleven layout body classes. * Filters the Twenty Eleven layout body classes.
* *
* @since Twenty Eleven 1.0 * @since Twenty Eleven 1.0
* *

View File

@ -26,7 +26,7 @@ get_header(); ?>
$tag_description = tag_description(); $tag_description = tag_description();
if ( ! empty( $tag_description ) ) { if ( ! empty( $tag_description ) ) {
/** /**
* Filter the default Twenty Eleven tag description. * Filters the default Twenty Eleven tag description.
* *
* @since Twenty Eleven 1.0 * @since Twenty Eleven 1.0
* *

View File

@ -13,7 +13,7 @@
<div class="author-avatar"> <div class="author-avatar">
<?php <?php
/** /**
* Filter the author bio avatar size. * Filters the author bio avatar size.
* *
* @since Twenty Fifteen 1.0 * @since Twenty Fifteen 1.0
* *

View File

@ -147,7 +147,7 @@ if ( ! function_exists( 'twentyfifteen_setup' ) ) :
add_theme_support( add_theme_support(
'custom-background', 'custom-background',
/** /**
* Filter Twenty Fifteen custom-background support arguments. * Filters Twenty Fifteen custom-background support arguments.
* *
* @since Twenty Fifteen 1.0 * @since Twenty Fifteen 1.0
* *

View File

@ -35,7 +35,7 @@ get_header(); ?>
<div class="entry-attachment"> <div class="entry-attachment">
<?php <?php
/** /**
* Filter the default Twenty Fifteen image attachment size. * Filters the default Twenty Fifteen image attachment size.
* *
* @since Twenty Fifteen 1.0 * @since Twenty Fifteen 1.0
* *

View File

@ -19,7 +19,7 @@ function twentyfifteen_custom_header_setup() {
add_theme_support( add_theme_support(
'custom-header', 'custom-header',
/** /**
* Filter Twenty Fifteen custom-header support arguments. * Filters Twenty Fifteen custom-header support arguments.
* *
* @since Twenty Fifteen 1.0 * @since Twenty Fifteen 1.0
* *

View File

@ -157,7 +157,7 @@ function twentyfifteen_customize_partial_blogdescription() {
*/ */
function twentyfifteen_get_color_schemes() { function twentyfifteen_get_color_schemes() {
/** /**
* Filter the color schemes registered for use with Twenty Fifteen. * Filters the color schemes registered for use with Twenty Fifteen.
* *
* The default schemes include 'default', 'dark', 'yellow', 'pink', 'purple', and 'blue'. * The default schemes include 'default', 'dark', 'yellow', 'pink', 'purple', and 'blue'.
* *

View File

@ -170,7 +170,7 @@ if ( ! function_exists( 'twentyfourteen_setup' ) ) :
add_theme_support( add_theme_support(
'custom-background', 'custom-background',
/** /**
* Filter Twenty Fourteen custom-background support arguments. * Filters Twenty Fourteen custom-background support arguments.
* *
* @since Twenty Fourteen 1.0 * @since Twenty Fourteen 1.0
* *
@ -227,7 +227,7 @@ add_action( 'template_redirect', 'twentyfourteen_content_width' );
*/ */
function twentyfourteen_get_featured_posts() { function twentyfourteen_get_featured_posts() {
/** /**
* Filter the featured posts to return in Twenty Fourteen. * Filters the featured posts to return in Twenty Fourteen.
* *
* @since Twenty Fourteen 1.0 * @since Twenty Fourteen 1.0
* *
@ -424,7 +424,7 @@ if ( ! function_exists( 'twentyfourteen_the_attached_image' ) ) :
function twentyfourteen_the_attached_image() { function twentyfourteen_the_attached_image() {
$post = get_post(); $post = get_post();
/** /**
* Filter the default Twenty Fourteen attachment size. * Filters the default Twenty Fourteen attachment size.
* *
* @since Twenty Fourteen 1.0 * @since Twenty Fourteen 1.0
* *

View File

@ -20,7 +20,7 @@ function twentyfourteen_custom_header_setup() {
add_theme_support( add_theme_support(
'custom-header', 'custom-header',
/** /**
* Filter Twenty Fourteen custom-header support arguments. * Filters Twenty Fourteen custom-header support arguments.
* *
* @since Twenty Fourteen 1.0 * @since Twenty Fourteen 1.0
* *

View File

@ -30,7 +30,7 @@ get_header();
<figure class="entry-attachment wp-block-image"> <figure class="entry-attachment wp-block-image">
<?php <?php
/** /**
* Filter the default twentynineteen image attachment size. * Filters the default twentynineteen image attachment size.
* *
* @since Twenty Sixteen 1.0 * @since Twenty Sixteen 1.0
* *

View File

@ -18,7 +18,7 @@ function twentynineteen_custom_colors_css() {
} }
/** /**
* Filter Twenty Nineteen default saturation level. * Filters Twenty Nineteen default saturation level.
* *
* @since Twenty Nineteen 1.0 * @since Twenty Nineteen 1.0
* *
@ -28,7 +28,7 @@ function twentynineteen_custom_colors_css() {
$saturation = absint( $saturation ) . '%'; $saturation = absint( $saturation ) . '%';
/** /**
* Filter Twenty Nineteen default selection saturation level. * Filters Twenty Nineteen default selection saturation level.
* *
* @since Twenty Nineteen 1.0 * @since Twenty Nineteen 1.0
* *
@ -38,7 +38,7 @@ function twentynineteen_custom_colors_css() {
$saturation_selection = $saturation_selection . '%'; $saturation_selection = $saturation_selection . '%';
/** /**
* Filter Twenty Nineteen default lightness level. * Filters Twenty Nineteen default lightness level.
* *
* @since Twenty Nineteen 1.0 * @since Twenty Nineteen 1.0
* *
@ -48,7 +48,7 @@ function twentynineteen_custom_colors_css() {
$lightness = absint( $lightness ) . '%'; $lightness = absint( $lightness ) . '%';
/** /**
* Filter Twenty Nineteen default hover lightness level. * Filters Twenty Nineteen default hover lightness level.
* *
* @since Twenty Nineteen 1.0 * @since Twenty Nineteen 1.0
* *
@ -58,7 +58,7 @@ function twentynineteen_custom_colors_css() {
$lightness_hover = absint( $lightness_hover ) . '%'; $lightness_hover = absint( $lightness_hover ) . '%';
/** /**
* Filter Twenty Nineteen default selection lightness level. * Filters Twenty Nineteen default selection lightness level.
* *
* @since Twenty Nineteen 1.0 * @since Twenty Nineteen 1.0
* *

View File

@ -34,7 +34,7 @@ get_header(); ?>
if ( 0 !== twentyseventeen_panel_count() || is_customize_preview() ) : // If we have pages to show. if ( 0 !== twentyseventeen_panel_count() || is_customize_preview() ) : // If we have pages to show.
/** /**
* Filter number of front page sections in Twenty Seventeen. * Filters the number of front page sections in Twenty Seventeen.
* *
* @since Twenty Seventeen 1.0 * @since Twenty Seventeen 1.0
* *

View File

@ -267,7 +267,7 @@ function twentyseventeen_content_width() {
} }
/** /**
* Filter Twenty Seventeen content width of the theme. * Filters Twenty Seventeen content width of the theme.
* *
* @since Twenty Seventeen 1.0 * @since Twenty Seventeen 1.0
* *
@ -544,7 +544,7 @@ function twentyseventeen_content_image_sizes_attr( $sizes, $size ) {
add_filter( 'wp_calculate_image_sizes', 'twentyseventeen_content_image_sizes_attr', 10, 2 ); add_filter( 'wp_calculate_image_sizes', 'twentyseventeen_content_image_sizes_attr', 10, 2 );
/** /**
* Filter the `sizes` value in the header image markup. * Filters the `sizes` value in the header image markup.
* *
* @since Twenty Seventeen 1.0 * @since Twenty Seventeen 1.0
* *

View File

@ -14,7 +14,7 @@ function twentyseventeen_custom_colors_css() {
$hue = absint( get_theme_mod( 'colorscheme_hue', 250 ) ); $hue = absint( get_theme_mod( 'colorscheme_hue', 250 ) );
/** /**
* Filter Twenty Seventeen default saturation level. * Filters Twenty Seventeen default saturation level.
* *
* @since Twenty Seventeen 1.0 * @since Twenty Seventeen 1.0
* *

View File

@ -19,7 +19,7 @@ function twentyseventeen_custom_header_setup() {
add_theme_support( add_theme_support(
'custom-header', 'custom-header',
/** /**
* Filter Twenty Seventeen custom-header support arguments. * Filters Twenty Seventeen custom-header support arguments.
* *
* @since Twenty Seventeen 1.0 * @since Twenty Seventeen 1.0
* *

View File

@ -116,7 +116,7 @@ function twentyseventeen_customize_register( $wp_customize ) {
); );
/** /**
* Filter number of front page sections in Twenty Seventeen. * Filters the number of front page sections in Twenty Seventeen.
* *
* @since Twenty Seventeen 1.0 * @since Twenty Seventeen 1.0
* *

View File

@ -213,7 +213,7 @@ function twentyseventeen_social_links_icons() {
); );
/** /**
* Filter Twenty Seventeen social links icons. * Filters Twenty Seventeen social links icons.
* *
* @since Twenty Seventeen 1.0 * @since Twenty Seventeen 1.0
* *

View File

@ -76,7 +76,7 @@ function twentyseventeen_panel_count() {
$panel_count = 0; $panel_count = 0;
/** /**
* Filter number of front page sections in Twenty Seventeen. * Filters the number of front page sections in Twenty Seventeen.
* *
* @since Twenty Seventeen 1.0 * @since Twenty Seventeen 1.0
* *

View File

@ -85,7 +85,7 @@
<?php if ( get_header_image() ) : ?> <?php if ( get_header_image() ) : ?>
<?php <?php
/** /**
* Filter the default twentysixteen custom header sizes attribute. * Filters the default twentysixteen custom header sizes attribute.
* *
* @since Twenty Sixteen 1.0 * @since Twenty Sixteen 1.0
* *

View File

@ -36,7 +36,7 @@ get_header(); ?>
<div class="entry-attachment"> <div class="entry-attachment">
<?php <?php
/** /**
* Filter the default twentysixteen image attachment size. * Filters the default twentysixteen image attachment size.
* *
* @since Twenty Sixteen 1.0 * @since Twenty Sixteen 1.0
* *

View File

@ -22,7 +22,7 @@ function twentysixteen_custom_header_and_background() {
add_theme_support( add_theme_support(
'custom-background', 'custom-background',
/** /**
* Filter the arguments used when adding 'custom-background' support in Twenty Sixteen. * Filters the arguments used when adding 'custom-background' support in Twenty Sixteen.
* *
* @since Twenty Sixteen 1.0 * @since Twenty Sixteen 1.0
* *
@ -43,7 +43,7 @@ function twentysixteen_custom_header_and_background() {
add_theme_support( add_theme_support(
'custom-header', 'custom-header',
/** /**
* Filter the arguments used when adding 'custom-header' support in Twenty Sixteen. * Filters the arguments used when adding 'custom-header' support in Twenty Sixteen.
* *
* @since Twenty Sixteen 1.0 * @since Twenty Sixteen 1.0
* *
@ -291,7 +291,7 @@ function twentysixteen_customize_partial_blogdescription() {
*/ */
function twentysixteen_get_color_schemes() { function twentysixteen_get_color_schemes() {
/** /**
* Filter the color schemes registered for use with Twenty Sixteen. * Filters the color schemes registered for use with Twenty Sixteen.
* *
* The default schemes include 'default', 'dark', 'gray', 'red', and 'yellow'. * The default schemes include 'default', 'dark', 'gray', 'red', and 'yellow'.
* *

View File

@ -12,7 +12,7 @@
<div class="author-avatar"> <div class="author-avatar">
<?php <?php
/** /**
* Filter the Twenty Sixteen author bio avatar size. * Filters the Twenty Sixteen author bio avatar size.
* *
* @since Twenty Sixteen 1.0 * @since Twenty Sixteen 1.0
* *

View File

@ -41,7 +41,7 @@ if ( get_the_author_meta( 'description' ) ) :
<div id="author-avatar"> <div id="author-avatar">
<?php <?php
/** /**
* Filter the Twenty Ten author bio avatar size. * Filters the Twenty Ten author bio avatar size.
* *
* @since Twenty Ten 1.0 * @since Twenty Ten 1.0
* *

View File

@ -157,7 +157,7 @@ if ( ! function_exists( 'twentyten_setup' ) ) :
'default-image' => '%s/images/headers/path.jpg', 'default-image' => '%s/images/headers/path.jpg',
// The height and width of our custom header. // The height and width of our custom header.
/** /**
* Filter the Twenty Ten default header image width. * Filters the Twenty Ten default header image width.
* *
* @since Twenty Ten 1.0 * @since Twenty Ten 1.0
* *
@ -165,7 +165,7 @@ if ( ! function_exists( 'twentyten_setup' ) ) :
*/ */
'width' => apply_filters( 'twentyten_header_image_width', 940 ), 'width' => apply_filters( 'twentyten_header_image_width', 940 ),
/** /**
* Filter the Twenty Ten defaul header image height. * Filters the Twenty Ten defaul header image height.
* *
* @since Twenty Ten 1.0 * @since Twenty Ten 1.0
* *

View File

@ -123,7 +123,7 @@ if ( have_posts() ) {
<p class="attachment"><a href="<?php echo esc_url( $next_attachment_url ); ?>" title="<?php the_title_attribute(); ?>" rel="attachment"> <p class="attachment"><a href="<?php echo esc_url( $next_attachment_url ); ?>" title="<?php the_title_attribute(); ?>" rel="attachment">
<?php <?php
/** /**
* Filter the Twenty Ten default attachment width. * Filters the Twenty Ten default attachment width.
* *
* @since Twenty Ten 1.0 * @since Twenty Ten 1.0
* *
@ -131,7 +131,7 @@ if ( have_posts() ) {
*/ */
$attachment_width = apply_filters( 'twentyten_attachment_size', 900 ); $attachment_width = apply_filters( 'twentyten_attachment_size', 900 );
/** /**
* Filter the Twenty Ten default attachment height. * Filters the Twenty Ten default attachment height.
* *
* @since Twenty Ten 1.0 * @since Twenty Ten 1.0
* *

View File

@ -12,7 +12,7 @@
<div class="author-avatar"> <div class="author-avatar">
<?php <?php
/** /**
* Filter the author bio avatar size. * Filters the author bio avatar size.
* *
* @since Twenty Thirteen 1.0 * @since Twenty Thirteen 1.0
* *

View File

@ -551,7 +551,7 @@ if ( ! function_exists( 'twentythirteen_the_attached_image' ) ) :
*/ */
function twentythirteen_the_attached_image() { function twentythirteen_the_attached_image() {
/** /**
* Filter the image attachment size to use. * Filters the image attachment size to use.
* *
* @since Twenty thirteen 1.0 * @since Twenty thirteen 1.0
* *

View File

@ -57,7 +57,7 @@ get_header(); ?>
<div class="author-avatar"> <div class="author-avatar">
<?php <?php
/** /**
* Filter the author bio avatar size. * Filters the author bio avatar size.
* *
* @since Twenty Twelve 1.0 * @since Twenty Twelve 1.0
* *

View File

@ -19,7 +19,7 @@ $post_title = sprintf( __( 'Permalink to %s', 'twentytwelve' ), the_title_attrib
</header> </header>
<?php <?php
/** /**
* Filter the status avatar size. * Filters the status avatar size.
* *
* @since Twenty Twelve 1.0 * @since Twenty Twelve 1.0
* *

View File

@ -93,7 +93,7 @@ get_header(); ?>
<a href="<?php echo esc_url( $next_attachment_url ); ?>" title="<?php the_title_attribute(); ?>" rel="attachment"> <a href="<?php echo esc_url( $next_attachment_url ); ?>" title="<?php the_title_attribute(); ?>" rel="attachment">
<?php <?php
/** /**
* Filter the image attachment size to use. * Filters the image attachment size to use.
* *
* @since Twenty Twelve 1.0 * @since Twenty Twelve 1.0
* *

View File

@ -503,7 +503,7 @@ if ( ! function_exists( 'twentytwenty_customize_partial_site_logo' ) ) {
*/ */
function twentytwenty_customize_opacity_range() { function twentytwenty_customize_opacity_range() {
/** /**
* Filter the input attributes for opacity * Filters the input attributes for opacity
* *
* @param array $attrs { * @param array $attrs {
* The attributes * The attributes

View File

@ -382,7 +382,7 @@ class WP_Comment_Query {
$comment_data = null; $comment_data = null;
/** /**
* Filter the comments data before the query takes place. * Filters the comments data before the query takes place.
* *
* Return a non-null value to bypass WordPress's default comment queries. * Return a non-null value to bypass WordPress's default comment queries.
* *

View File

@ -1941,7 +1941,7 @@ final class WP_Customize_Manager {
} }
/** /**
* Filter the X-Frame-Options and Content-Security-Policy headers to ensure frontend can load in customizer. * Filters the X-Frame-Options and Content-Security-Policy headers to ensure frontend can load in customizer.
* *
* @since 4.7.0 * @since 4.7.0
* *
@ -3276,7 +3276,7 @@ final class WP_Customize_Manager {
} }
/** /**
* Filter heartbeat settings for the Customizer. * Filters heartbeat settings for the Customizer.
* *
* @since 4.9.0 * @since 4.9.0
* @param array $settings Current settings to filter. * @param array $settings Current settings to filter.

View File

@ -200,7 +200,7 @@ class WP_Network_Query {
$network_data = null; $network_data = null;
/** /**
* Filter the network data before the query takes place. * Filters the network data before the query takes place.
* *
* Return a non-null value to bypass WordPress's default network queries. * Return a non-null value to bypass WordPress's default network queries.
* *

View File

@ -36,13 +36,14 @@ final class WP_Recovery_Mode_Cookie_Service {
$value = $this->generate_cookie(); $value = $this->generate_cookie();
/** /**
* Filter the length of time a Recovery Mode cookie is valid for. * Filters the length of time a Recovery Mode cookie is valid for.
* *
* @since 5.2.0 * @since 5.2.0
* *
* @param int $length Length in seconds. * @param int $length Length in seconds.
*/ */
$length = apply_filters( 'recovery_mode_cookie_length', WEEK_IN_SECONDS ); $length = apply_filters( 'recovery_mode_cookie_length', WEEK_IN_SECONDS );
$expire = time() + $length; $expire = time() + $length;
setcookie( RECOVERY_MODE_COOKIE, $value, $expire, COOKIEPATH, COOKIE_DOMAIN, is_ssl(), true ); setcookie( RECOVERY_MODE_COOKIE, $value, $expire, COOKIEPATH, COOKIE_DOMAIN, is_ssl(), true );

View File

@ -202,7 +202,7 @@ When seeking help with this issue, you may be asked for some of the following in
); );
/** /**
* Filter the contents of the Recovery Mode email. * Filters the contents of the Recovery Mode email.
* *
* @since 5.2.0 * @since 5.2.0
* *

View File

@ -114,7 +114,7 @@ class WP_Recovery_Mode_Link_Service {
); );
/** /**
* Filter the URL to begin recovery mode. * Filters the URL to begin recovery mode.
* *
* @since 5.2.0 * @since 5.2.0
* *

View File

@ -297,7 +297,7 @@ class WP_Recovery_Mode {
*/ */
protected function get_email_rate_limit() { protected function get_email_rate_limit() {
/** /**
* Filter the rate limit between sending new recovery mode email links. * Filters the rate limit between sending new recovery mode email links.
* *
* @since 5.2.0 * @since 5.2.0
* *
@ -319,7 +319,7 @@ class WP_Recovery_Mode {
$valid_for = $rate_limit; $valid_for = $rate_limit;
/** /**
* Filter the amount of time the recovery mode email link is valid for. * Filters the amount of time the recovery mode email link is valid for.
* *
* The ttl must be at least as long as the email rate limit. * The ttl must be at least as long as the email rate limit.
* *

View File

@ -291,7 +291,7 @@ class WP_Site_Query {
$site_data = null; $site_data = null;
/** /**
* Filter the site data before the get_sites query takes place. * Filters the site data before the get_sites query takes place.
* *
* Return a non-null value to bypass WordPress's default site queries. * Return a non-null value to bypass WordPress's default site queries.
* *

View File

@ -688,7 +688,7 @@ class WP_Term_Query {
$this->terms = null; $this->terms = null;
/** /**
* Filter the terms array before the query takes place. * Filters the terms array before the query takes place.
* *
* Return a non-null value to bypass WordPress's default term queries. * Return a non-null value to bypass WordPress's default term queries.
* *

View File

@ -863,7 +863,7 @@ function wp_get_schedule( $hook, $args = array() ) {
} }
/** /**
* Filter the schedule for a hook. * Filters the schedule for a hook.
* *
* @since 5.1.0 * @since 5.1.0
* *

View File

@ -90,7 +90,7 @@ final class WP_Customize_Custom_CSS_Setting extends WP_Customize_Setting {
} }
/** /**
* Filter `wp_get_custom_css` for applying the customized value. * Filters `wp_get_custom_css` for applying the customized value.
* *
* This is used in the preview when `wp_get_custom_css()` is called for rendering the styles. * This is used in the preview when `wp_get_custom_css()` is called for rendering the styles.
* *

View File

@ -1553,7 +1553,7 @@ function wp_image_file_matches_image_meta( $image_location, $image_meta, $attach
} }
/** /**
* Filter whether an image path or URI matches image meta. * Filters whether an image path or URI matches image meta.
* *
* @since 5.5.0 * @since 5.5.0
* *

View File

@ -7330,7 +7330,7 @@ function wp_add_trashed_suffix_to_post_name_for_post( $post ) {
} }
/** /**
* Filter the SQL clauses of an attachment query to include filenames. * Filters the SQL clauses of an attachment query to include filenames.
* *
* @since 4.7.0 * @since 4.7.0
* @access private * @access private

View File

@ -786,7 +786,7 @@ function _rest_array_intersect_key_recursive( $array1, $array2 ) {
} }
/** /**
* Filter the API response to include only a white-listed set of response object fields. * Filters the API response to include only a white-listed set of response object fields.
* *
* @since 4.8.0 * @since 4.8.0
* *

View File

@ -308,7 +308,7 @@ class WP_REST_Block_Directory_Controller extends WP_REST_Controller {
unset( $query_params['search'] ); unset( $query_params['search'] );
/** /**
* Filter collection parameters for the block directory controller. * Filters collection parameters for the block directory controller.
* *
* @since 5.5.0 * @since 5.5.0
* *

View File

@ -449,7 +449,7 @@ class WP_REST_Comments_Controller extends WP_REST_Controller {
} }
/** /**
* Filter whether comments can be created without authentication. * Filters whether comments can be created without authentication.
* *
* Enables creating comments for anonymous users. * Enables creating comments for anonymous users.
* *
@ -1676,7 +1676,7 @@ class WP_REST_Comments_Controller extends WP_REST_Controller {
); );
/** /**
* Filter collection parameters for the comments controller. * Filters collection parameters for the comments controller.
* *
* This filter registers the collection parameter, but does not map the * This filter registers the collection parameter, but does not map the
* collection parameter to an internal WP_Comment_Query parameter. Use the * collection parameter to an internal WP_Comment_Query parameter. Use the

View File

@ -2411,7 +2411,7 @@ class WP_REST_Posts_Controller extends WP_REST_Controller {
$schema_fields = array_keys( $schema['properties'] ); $schema_fields = array_keys( $schema['properties'] );
/** /**
* Filter the post's schema. * Filters the post's schema.
* *
* The dynamic portion of the filter, `$this->post_type`, refers to the * The dynamic portion of the filter, `$this->post_type`, refers to the
* post type slug for the controller. * post type slug for the controller.
@ -2752,7 +2752,7 @@ class WP_REST_Posts_Controller extends WP_REST_Controller {
} }
/** /**
* Filter collection parameters for the posts controller. * Filters collection parameters for the posts controller.
* *
* The dynamic part of the filter `$this->post_type` refers to the post * The dynamic part of the filter `$this->post_type` refers to the post
* type slug for the controller. * type slug for the controller.

View File

@ -1081,7 +1081,7 @@ class WP_REST_Terms_Controller extends WP_REST_Controller {
); );
/** /**
* Filter collection parameters for the terms controller. * Filters collection parameters for the terms controller.
* *
* The dynamic part of the filter `$this->taxonomy` refers to the taxonomy * The dynamic part of the filter `$this->taxonomy` refers to the taxonomy
* slug for the controller. * slug for the controller.

View File

@ -439,7 +439,7 @@ class WP_REST_Themes_Controller extends WP_REST_Controller {
); );
/** /**
* Filter collection parameters for the themes controller. * Filters collection parameters for the themes controller.
* *
* @since 5.0.0 * @since 5.0.0
* *

View File

@ -1559,7 +1559,7 @@ class WP_REST_Users_Controller extends WP_REST_Controller {
); );
/** /**
* Filter collection parameters for the users controller. * Filters collection parameters for the users controller.
* *
* This filter registers the collection parameter, but does not map the * This filter registers the collection parameter, but does not map the
* collection parameter to an internal WP_User_Query parameter. Use the * collection parameter to an internal WP_User_Query parameter. Use the

View File

@ -38,7 +38,7 @@ class WP_Sitemaps_Taxonomies extends WP_Sitemaps_Provider {
$taxonomies = array_filter( $taxonomies, 'is_taxonomy_viewable' ); $taxonomies = array_filter( $taxonomies, 'is_taxonomy_viewable' );
/** /**
* Filter the list of taxonomy object subtypes available within the sitemap. * Filters the list of taxonomy object subtypes available within the sitemap.
* *
* @since 5.5.0 * @since 5.5.0
* *

View File

@ -2050,7 +2050,7 @@ function wp_get_object_terms( $object_ids, $taxonomies, $args = array() ) {
$args = wp_parse_args( $args ); $args = wp_parse_args( $args );
/** /**
* Filter arguments for retrieving object terms. * Filters arguments for retrieving object terms.
* *
* @since 4.9.0 * @since 4.9.0
* *

View File

@ -105,7 +105,7 @@ function wp_version_check( $extra_stats = array(), $force_check = false ) {
); );
/** /**
* Filter the query arguments sent as part of the core version check. * Filters the query arguments sent as part of the core version check.
* *
* WARNING: Changing this data may result in your site not receiving security updates. * WARNING: Changing this data may result in your site not receiving security updates.
* Please exercise extreme caution. * Please exercise extreme caution.

View File

@ -896,8 +896,9 @@ function count_users( $strategy = 'time', $site_id = null ) {
} }
/** /**
* Filter the user count before queries are run. Return a non-null value to cause count_users() * Filters the user count before queries are run.
* to return early. *
* Return a non-null value to cause count_users() to return early.
* *
* @since 5.1.0 * @since 5.1.0
* *

View File

@ -83,7 +83,7 @@ class WP_Widget_Custom_HTML extends WP_Widget {
} }
/** /**
* Filter gallery shortcode attributes. * Filters gallery shortcode attributes.
* *
* Prevents all of a site's attachments from being shown in a gallery displayed on a * Prevents all of a site's attachments from being shown in a gallery displayed on a
* non-singular template where a $post context is not available. * non-singular template where a $post context is not available.

View File

@ -193,7 +193,7 @@ class WP_Widget_Text extends WP_Widget {
} }
/** /**
* Filter gallery shortcode attributes. * Filters gallery shortcode attributes.
* *
* Prevents all of a site's attachments from being shown in a gallery displayed on a * Prevents all of a site's attachments from being shown in a gallery displayed on a
* non-singular template where a $post context is not available. * non-singular template where a $post context is not available.