Docs: Miscellaneous corrections and improvements to docblocks.

See #57840

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


git-svn-id: http://core.svn.wordpress.org/trunk@55382 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
John Blackbourn 2023-05-30 17:45:21 +00:00
parent 37e599fb3e
commit bb9b9d17f4
4 changed files with 22 additions and 12 deletions

View File

@ -7575,7 +7575,7 @@ function wp_raise_memory_limit( $context = 'admin' ) {
* @since 3.5.0 * @since 3.5.0
* @since 4.6.0 The default now takes the original `memory_limit` into account. * @since 4.6.0 The default now takes the original `memory_limit` into account.
* *
* @param int|string $filtered_limit Maximum memory limit to allocate for images. * @param int|string $filtered_limit Maximum memory limit to allocate for image processing.
* Default `WP_MAX_MEMORY_LIMIT` or the original * Default `WP_MAX_MEMORY_LIMIT` or the original
* php.ini `memory_limit`, whichever is higher. * php.ini `memory_limit`, whichever is higher.
* Accepts an integer (bytes), or a shorthand string * Accepts an integer (bytes), or a shorthand string
@ -7586,7 +7586,7 @@ function wp_raise_memory_limit( $context = 'admin' ) {
default: default:
/** /**
* Filters the memory limit allocated for arbitrary contexts. * Filters the memory limit allocated for an arbitrary context.
* *
* The dynamic portion of the hook name, `$context`, refers to an arbitrary * The dynamic portion of the hook name, `$context`, refers to an arbitrary
* context passed on calling the function. This allows for plugins to define * context passed on calling the function. This allows for plugins to define
@ -7594,8 +7594,8 @@ function wp_raise_memory_limit( $context = 'admin' ) {
* *
* @since 4.6.0 * @since 4.6.0
* *
* @param int|string $filtered_limit Maximum memory limit to allocate for images. * @param int|string $filtered_limit Maximum memory limit to allocate for this context.
* Default '256M' or the original php.ini `memory_limit`, * Default WP_MAX_MEMORY_LIMIT` or the original php.ini `memory_limit`,
* whichever is higher. Accepts an integer (bytes), or a * whichever is higher. Accepts an integer (bytes), or a
* shorthand string notation, such as '256M'. * shorthand string notation, such as '256M'.
*/ */

View File

@ -158,10 +158,10 @@ function get_sidebar( $name = null, $args = array() ) {
* @since 5.5.0 A return value was added. * @since 5.5.0 A return value was added.
* @since 5.5.0 The `$args` parameter was added. * @since 5.5.0 The `$args` parameter was added.
* *
* @param string $slug The slug name for the generic template. * @param string $slug The slug name for the generic template.
* @param string $name The name of the specialized template. * @param string|null $name Optional. The name of the specialized template.
* @param array $args Optional. Additional arguments passed to the template. * @param array $args Optional. Additional arguments passed to the template.
* Default empty array. * Default empty array.
* @return void|false Void on success, false if the template does not exist. * @return void|false Void on success, false if the template does not exist.
*/ */
function get_template_part( $slug, $name = null, $args = array() ) { function get_template_part( $slug, $name = null, $args = array() ) {
@ -175,7 +175,8 @@ function get_template_part( $slug, $name = null, $args = array() ) {
* @since 5.5.0 The `$args` parameter was added. * @since 5.5.0 The `$args` parameter was added.
* *
* @param string $slug The slug name for the generic template. * @param string $slug The slug name for the generic template.
* @param string|null $name The name of the specialized template. * @param string|null $name The name of the specialized template or null if
* there is none.
* @param array $args Additional arguments passed to the template. * @param array $args Additional arguments passed to the template.
*/ */
do_action( "get_template_part_{$slug}", $slug, $name, $args ); do_action( "get_template_part_{$slug}", $slug, $name, $args );
@ -195,7 +196,8 @@ function get_template_part( $slug, $name = null, $args = array() ) {
* @since 5.5.0 The `$args` parameter was added. * @since 5.5.0 The `$args` parameter was added.
* *
* @param string $slug The slug name for the generic template. * @param string $slug The slug name for the generic template.
* @param string $name The name of the specialized template. * @param string $name The name of the specialized template or an empty
* string if there is none.
* @param string[] $templates Array of template files to search for, in order. * @param string[] $templates Array of template files to search for, in order.
* @param array $args Additional arguments passed to the template. * @param array $args Additional arguments passed to the template.
*/ */

View File

@ -3087,7 +3087,15 @@ function wp_enqueue_stored_styles( $options = array() ) {
* @since 5.9.0 * @since 5.9.0
* *
* @param string $block_name The block-name, including namespace. * @param string $block_name The block-name, including namespace.
* @param array $args An array of arguments [handle,src,deps,ver,media]. * @param array $args {
* An array of arguments. See wp_register_style() for full information about each argument.
*
* @type string $handle The handle for the stylesheet.
* @type string|false $src The source URL of the stylesheet.
* @type string[] $deps Array of registered stylesheet handles this stylesheet depends on.
* @type string|bool|null $ver Stylesheet version number.
* @type string $media The media for which this stylesheet has been defined.
* }
*/ */
function wp_enqueue_block_style( $block_name, $args ) { function wp_enqueue_block_style( $block_name, $args ) {
$args = wp_parse_args( $args = wp_parse_args(

View File

@ -16,7 +16,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '6.3-alpha-55869'; $wp_version = '6.3-alpha-55870';
/** /**
* 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.