From f5bd63d352b0aa4601ee390931e2c64aeed5bf9c Mon Sep 17 00:00:00 2001 From: Sergey Biryukov Date: Mon, 18 Jan 2021 12:28:07 +0000 Subject: [PATCH] Docs: Link to the parent function for accepted arguments in some filters for HTML output. See #51800. Built from https://develop.svn.wordpress.org/trunk@49977 git-svn-id: http://core.svn.wordpress.org/trunk@49678 1a063a9b-81f0-0310-95a4-ce76da25c4cd --- wp-includes/category-template.php | 6 ++++-- wp-includes/general-template.php | 7 ++++++- wp-includes/post-template.php | 18 ++++++++++++------ wp-includes/version.php | 2 +- 4 files changed, 23 insertions(+), 10 deletions(-) diff --git a/wp-includes/category-template.php b/wp-includes/category-template.php index 2da86c4b68..5a62cc8b3b 100644 --- a/wp-includes/category-template.php +++ b/wp-includes/category-template.php @@ -662,7 +662,8 @@ function wp_list_categories( $args = '' ) { * @since 2.1.0 * * @param string $output HTML output. - * @param array $args An array of taxonomy-listing arguments. + * @param array $args An array of taxonomy-listing arguments. See wp_list_categories() + * for information on accepted arguments. */ $html = apply_filters( 'wp_list_categories', $output, $args ); @@ -758,7 +759,8 @@ function wp_tag_cloud( $args = '' ) { * @since 2.3.0 * * @param string|string[] $return Tag cloud as a string or an array, depending on 'format' argument. - * @param array $args An array of tag cloud arguments. + * @param array $args An array of tag cloud arguments. See wp_tag_cloud() + * for information on accepted arguments. */ $return = apply_filters( 'wp_tag_cloud', $return, $args ); diff --git a/wp-includes/general-template.php b/wp-includes/general-template.php index 2963113ef0..2fbfc4c3c2 100644 --- a/wp-includes/general-template.php +++ b/wp-includes/general-template.php @@ -247,6 +247,7 @@ function get_search_form( $args = array() ) { * @link https://core.trac.wordpress.org/ticket/19321 * * @param array $args The array of arguments for building the search form. + * See get_search_form() for information on accepted arguments. */ do_action( 'pre_get_search_form', $args ); @@ -278,6 +279,7 @@ function get_search_form( $args = array() ) { * @since 5.2.0 * * @param array $args The array of arguments for building the search form. + * See get_search_form() for information on accepted arguments. */ $args = apply_filters( 'search_form_args', $args ); @@ -295,6 +297,7 @@ function get_search_form( $args = array() ) { * @param string $format The type of markup to use in the search form. * Accepts 'html5', 'xhtml'. * @param array $args The array of arguments for building the search form. + * See get_search_form() for information on accepted arguments. */ $format = apply_filters( 'search_form_format', $format, $args ); @@ -343,6 +346,7 @@ function get_search_form( $args = array() ) { * * @param string $form The search form HTML output. * @param array $args The array of arguments for building the search form. + * See get_search_form() for information on accepted arguments. */ $result = apply_filters( 'get_search_form', $form, $args ); @@ -4363,7 +4367,8 @@ function paginate_links( $args = '' ) { * @since 5.7.0 * * @param string $r HTML output. - * @param array $args An array of arguments. See paginate_links() for accepted arguments. + * @param array $args An array of arguments. See paginate_links() + * for information on accepted arguments. */ $r = apply_filters( 'paginate_links_output', $r, $args ); diff --git a/wp-includes/post-template.php b/wp-includes/post-template.php index 808e491349..0ad352c328 100644 --- a/wp-includes/post-template.php +++ b/wp-includes/post-template.php @@ -946,7 +946,8 @@ function wp_link_pages( $args = '' ) { * * @since 3.0.0 * - * @param array $parsed_args An array of arguments for page links for paginated posts. + * @param array $parsed_args An array of page link arguments. See wp_link_pages() + * for information on accepted arguments. */ $parsed_args = apply_filters( 'wp_link_pages_args', $parsed_args ); @@ -1005,7 +1006,8 @@ function wp_link_pages( $args = '' ) { * @since 3.6.0 * * @param string $output HTML output of paginated posts' page links. - * @param array $args An array of arguments. + * @param array $args An array of arguments. See wp_link_pages() + * for information on accepted arguments. */ $html = apply_filters( 'wp_link_pages', $output, $args ); @@ -1208,7 +1210,8 @@ function wp_dropdown_pages( $args = '' ) { * @since 4.4.0 `$parsed_args` and `$pages` added as arguments. * * @param string $output HTML output for drop down list of pages. - * @param array $parsed_args The parsed arguments array. + * @param array $parsed_args The parsed arguments array. See wp_dropdown_pages() + * for information on accepted arguments. * @param WP_Post[] $pages Array of the page objects. */ $html = apply_filters( 'wp_dropdown_pages', $output, $parsed_args, $pages ); @@ -1337,7 +1340,8 @@ function wp_list_pages( $args = '' ) { * @see wp_list_pages() * * @param string $output HTML output of the pages list. - * @param array $parsed_args An array of page-listing arguments. + * @param array $parsed_args An array of page-listing arguments. See wp_list_pages() + * for information on accepted arguments. * @param WP_Post[] $pages Array of the page objects. */ $html = apply_filters( 'wp_list_pages', $output, $parsed_args, $pages ); @@ -1417,7 +1421,8 @@ function wp_page_menu( $args = array() ) { * * @see wp_page_menu() * - * @param array $args An array of page menu arguments. + * @param array $args An array of page menu arguments. See wp_page_menu() + * for information on accepted arguments. */ $args = apply_filters( 'wp_page_menu_args', $args ); @@ -1491,7 +1496,8 @@ function wp_page_menu( $args = array() ) { * @see wp_page_menu() * * @param string $menu The HTML output. - * @param array $args An array of arguments. + * @param array $args An array of arguments. See wp_page_menu() + * for information on accepted arguments. */ $menu = apply_filters( 'wp_page_menu', $menu, $args ); diff --git a/wp-includes/version.php b/wp-includes/version.php index 61f966b21a..3b13227c2d 100644 --- a/wp-includes/version.php +++ b/wp-includes/version.php @@ -13,7 +13,7 @@ * * @global string $wp_version */ -$wp_version = '5.7-alpha-49976'; +$wp_version = '5.7-alpha-49977'; /** * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.