Docs: Improvements and corrections for the `$ver` parameter of the dependencies API functions.
See #32246 git-svn-id: https://develop.svn.wordpress.org/trunk@36993 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
parent
6c972cbaff
commit
97c7cff31f
|
@ -204,11 +204,13 @@ class WP_Dependencies {
|
|||
* @since 2.1.0
|
||||
* @since 2.6.0 Moved from `WP_Scripts`.
|
||||
*
|
||||
* @param string $handle Unique item name.
|
||||
* @param string $src The item url.
|
||||
* @param array $deps Optional. An array of item handle strings on which this item depends.
|
||||
* @param string $ver Optional. Version (used for cache busting).
|
||||
* @param mixed $args Optional. Custom property of the item. NOT the class property $args. Examples: $media, $in_footer.
|
||||
* @param string $handle Name of the item. Should be unique.
|
||||
* @param string $src Full URL of the item, or path of the item relative to the WordPress root directory.
|
||||
* @param array $deps Optional. An array of registered item handles this item depends on. Default empty array.
|
||||
* @param string|bool|null $ver Optional. String specifying item version number, if it has one, which is added to the URL
|
||||
* as a query string for cache busting purposes. If version is set to false, a version
|
||||
* number is automatically added equal to current installed WordPress version.
|
||||
* If set to null, no version is added.
|
||||
* @return bool Whether the item has been registered. True on success, false on failure.
|
||||
*/
|
||||
public function add( $handle, $src, $deps = array(), $ver = false, $args = null ) {
|
||||
|
|
|
@ -97,7 +97,7 @@ function wp_print_scripts( $handles = false ) {
|
|||
*
|
||||
* @see WP_Scripts::add_inline_script()
|
||||
*
|
||||
* @param string $handle Name of the script to add the inline script to. Must be lowercase.
|
||||
* @param string $handle Name of the script to add the inline script to.
|
||||
* @param string $data String containing the javascript to be added.
|
||||
* @param string $position Optional. Whether to add the inline script before the handle
|
||||
* or after. Default 'after'.
|
||||
|
@ -117,7 +117,7 @@ function wp_add_inline_script( $handle, $data, $position = 'after' ) {
|
|||
/**
|
||||
* Register a new script.
|
||||
*
|
||||
* Registers a script to be linked later using the wp_enqueue_script() function.
|
||||
* Registers a script to be enqueued later using the wp_enqueue_script() function.
|
||||
*
|
||||
* @see WP_Dependencies::add()
|
||||
* @see WP_Dependencies::add_data()
|
||||
|
@ -126,15 +126,14 @@ function wp_add_inline_script( $handle, $data, $position = 'after' ) {
|
|||
* @since 4.3.0 A return value was added.
|
||||
*
|
||||
* @param string $handle Name of the script. Should be unique.
|
||||
* @param string $src Path to the script from the WordPress root directory. Example: '/js/myscript.js'.
|
||||
* @param array $deps Optional. An array of registered script handles this script depends on. Set to false if there
|
||||
* are no dependencies. Default empty array.
|
||||
* @param string|bool $ver Optional. String specifying script version number, if it has one, which is concatenated
|
||||
* to end of path as a query string. If no version is specified or set to false, a version
|
||||
* @param string $src Full URL of the script, or path of the script relative to the WordPress root directory.
|
||||
* @param array $deps Optional. An array of registered script handles this script depends on. Default empty array.
|
||||
* @param string|bool|null $ver Optional. String specifying script version number, if it has one, which is added to the URL
|
||||
* as a query string for cache busting purposes. If version is set to false, a version
|
||||
* number is automatically added equal to current installed WordPress version.
|
||||
* If set to null, no version is added. Default 'false'. Accepts 'false', 'null', or 'string'.
|
||||
* @param bool $in_footer Optional. Whether to enqueue the script before </head> or before </body>.
|
||||
* Default 'false'. Accepts 'false' or 'true'.
|
||||
* If set to null, no version is added.
|
||||
* @param bool $in_footer Optional. Whether to enqueue the script before </body> instead of in the <head>.
|
||||
* Default 'false'.
|
||||
* @return bool Whether the script has been registered. True on success, false on failure.
|
||||
*/
|
||||
function wp_register_script( $handle, $src, $deps = array(), $ver = false, $in_footer = false ) {
|
||||
|
@ -241,14 +240,15 @@ function wp_deregister_script( $handle ) {
|
|||
*
|
||||
* @since 2.1.0
|
||||
*
|
||||
* @param string $handle Name of the script.
|
||||
* @param string|bool $src Path to the script from the root directory of WordPress. Example: '/js/myscript.js'.
|
||||
* @param array $deps An array of registered handles this script depends on. Default empty array.
|
||||
* @param string|bool $ver Optional. String specifying the script version number, if it has one. This parameter
|
||||
* is used to ensure that the correct version is sent to the client regardless of caching,
|
||||
* and so should be included if a version number is available and makes sense for the script.
|
||||
* @param bool $in_footer Optional. Whether to enqueue the script before </head> or before </body>.
|
||||
* Default 'false'. Accepts 'false' or 'true'.
|
||||
* @param string $handle Name of the script. Should be unique.
|
||||
* @param string $src Full URL of the script, or path of the script relative to the WordPress root directory.
|
||||
* @param array $deps Optional. An array of registered script handles this script depends on. Default empty array.
|
||||
* @param string|bool|null $ver Optional. String specifying script version number, if it has one, which is added to the URL
|
||||
* as a query string for cache busting purposes. If version is set to false, a version
|
||||
* number is automatically added equal to current installed WordPress version.
|
||||
* If set to null, no version is added.
|
||||
* @param bool $in_footer Optional. Whether to enqueue the script before </body> instead of in the <head>.
|
||||
* Default 'false'.
|
||||
*/
|
||||
function wp_enqueue_script( $handle, $src = false, $deps = array(), $ver = false, $in_footer = false ) {
|
||||
$wp_scripts = wp_scripts();
|
||||
|
|
|
@ -76,7 +76,7 @@ function wp_print_styles( $handles = false ) {
|
|||
*
|
||||
* @since 3.3.0
|
||||
*
|
||||
* @param string $handle Name of the stylesheet to add the extra styles to. Must be lowercase.
|
||||
* @param string $handle Name of the stylesheet to add the extra styles to.
|
||||
* @param string $data String containing the CSS styles to be added.
|
||||
* @return bool True on success, false on failure.
|
||||
*/
|
||||
|
@ -100,15 +100,16 @@ function wp_add_inline_style( $handle, $data ) {
|
|||
* @since 2.6.0
|
||||
* @since 4.3.0 A return value was added.
|
||||
*
|
||||
* @param string $handle Name of the stylesheet.
|
||||
* @param string|bool $src Path to the stylesheet from the WordPress root directory. Example: '/css/mystyle.css'.
|
||||
* @param array $deps An array of registered style handles this stylesheet depends on. Default empty array.
|
||||
* @param string|bool $ver String specifying the stylesheet version number. Used to ensure that the correct version
|
||||
* is sent to the client regardless of caching. Default 'false'. Accepts 'false', 'null', or 'string'.
|
||||
* @param string $handle Name of the stylesheet. Should be unique.
|
||||
* @param string $src Full URL of the stylesheet, or path of the stylesheet relative to the WordPress root directory.
|
||||
* @param array $deps Optional. An array of registered stylesheet handles this stylesheet depends on. Default empty array.
|
||||
* @param string|bool|null $ver Optional. String specifying stylesheet version number, if it has one, which is added to the URL
|
||||
* as a query string for cache busting purposes. If version is set to false, a version
|
||||
* number is automatically added equal to current installed WordPress version.
|
||||
* If set to null, no version is added.
|
||||
* @param string $media Optional. The media for which this stylesheet has been defined.
|
||||
* Default 'all'. Accepts media types like 'all', 'print' and 'screen', or media queries like
|
||||
* '(orientation: portrait)' and '(max-width: 640px)'.
|
||||
*
|
||||
* @return bool Whether the style has been registered. True on success, false on failure.
|
||||
*/
|
||||
function wp_register_style( $handle, $src, $deps = array(), $ver = false, $media = 'all' ) {
|
||||
|
@ -143,12 +144,13 @@ function wp_deregister_style( $handle ) {
|
|||
*
|
||||
* @since 2.6.0
|
||||
*
|
||||
* @param string $handle Name of the stylesheet.
|
||||
* @param string|bool $src Path to the stylesheet from the root directory of WordPress. Example: '/css/mystyle.css'.
|
||||
* @param array $deps An array of registered style handles this stylesheet depends on. Default empty array.
|
||||
* @param string|bool $ver String specifying the stylesheet version number, if it has one. This parameter is used
|
||||
* to ensure that the correct version is sent to the client regardless of caching, and so
|
||||
* should be included if a version number is available and makes sense for the stylesheet.
|
||||
* @param string $handle Name of the stylesheet. Should be unique.
|
||||
* @param string $src Full URL of the stylesheet, or path of the stylesheet relative to the WordPress root directory.
|
||||
* @param array $deps Optional. An array of registered stylesheet handles this stylesheet depends on. Default empty array.
|
||||
* @param string|bool|null $ver Optional. String specifying stylesheet version number, if it has one, which is added to the URL
|
||||
* as a query string for cache busting purposes. If version is set to false, a version
|
||||
* number is automatically added equal to current installed WordPress version.
|
||||
* If set to null, no version is added.
|
||||
* @param string $media Optional. The media for which this stylesheet has been defined.
|
||||
* Default 'all'. Accepts media types like 'all', 'print' and 'screen', or media queries like
|
||||
* '(orientation: portrait)' and '(max-width: 640px)'.
|
||||
|
|
Loading…
Reference in New Issue