Commit Graph

66 Commits

Author SHA1 Message Date
John Blackbourn
a99a48c3b9 Docs: Various improvements to inline docblocks.
See #55646


git-svn-id: https://develop.svn.wordpress.org/trunk@54470 602fd350-edb4-49c9-b593-d223f7449a82
2022-10-11 09:00:33 +00:00
Sergey Biryukov
7a74026b21 I18N: Use correct default value for JavaScript translations path.
The `$path` parameter of some script translation functions had a default value of `null`, even though the parameter is documented as a string.

This commit corrects the default value for `$path` in:
* `WP_Dependency::set_translations()`
* `WP_Scripts::set_translations()`
* `wp_set_script_translations()`

Additionally, this commit removes an `is_string()` check for `$path` in `load_script_textdomain()`. Now that the default value for `$path` in that function has also been corrected to an empty string instead of `null`, that check is no longer necessary, as it would ''hide'' an error which should be ''fixed'' (at the source of the problem) instead.

Follow-up to [54349].

Props jrf, johnjamesjacoby.
See #55967, #55656.

git-svn-id: https://develop.svn.wordpress.org/trunk@54351 602fd350-edb4-49c9-b593-d223f7449a82
2022-09-28 22:17:38 +00:00
Sergey Biryukov
8277055e37 Docs: Add missing description for $pagenow global in various functions.
See #54729, #55499.

git-svn-id: https://develop.svn.wordpress.org/trunk@53060 602fd350-edb4-49c9-b593-d223f7449a82
2022-04-04 18:24:18 +00:00
Sergey Biryukov
25bff41798 Docs: Further remove HTML markup from various function summaries.
Per the [https://developer.wordpress.org/coding-standards/inline-documentation-standards/php/#summary-formerly-short-description WordPress PHP documentation standards], no HTML markup or Markdown of any kind should be used in the summary. This ensures that the summary is displayed correctly in the [https://developer.wordpress.org/reference/ WordPress Code Reference].

This commit also improves formatting of HTML special characters in descriptions in `wp-includes/formatting.php`.

Follow-up to [53048].

Props johnbillion, mukesh27.
Fixes #55506.

git-svn-id: https://develop.svn.wordpress.org/trunk@53053 602fd350-edb4-49c9-b593-d223f7449a82
2022-04-02 13:53:06 +00:00
Sergey Biryukov
40edc2addb Docs: Provide a more accurate description for a few script and style functions.
This should make it clear that the functions only work if the script or style has already been registered.

This affects:
* `wp_localize_script()`
* `wp_set_script_translations()`
* `wp_script_add_data()`
* `wp_style_add_data()`

Follow-up to [7970], [18464], [25594], [31223], [36633], [44169], [44350].

Props audrasjb.
Fixes #54044.

git-svn-id: https://develop.svn.wordpress.org/trunk@51726 602fd350-edb4-49c9-b593-d223f7449a82
2021-09-02 08:29:03 +00:00
Sergey Biryukov
f04ebe2daf Coding Standards: Remove a one-time $message variable in some _doing_it_wrong() calls.
This brings some consistency with most other calls.

Follow-up to [23378], [25605], [34745], [36219], [44108], [46111], [48156].

See #52627.

git-svn-id: https://develop.svn.wordpress.org/trunk@51154 602fd350-edb4-49c9-b593-d223f7449a82
2021-06-15 15:21:50 +00:00
Sergey Biryukov
24f0d03a6c Script Loader: Explicitly declare the $pagenow global in wp_deregister_script().
This avoids an "Undefined index" PHP notice in `wp_resource_hints()` tests when running the full test suite.

Remove the unused global from `get_home_url()`.

Follow-up to [25443], [38100], [38174], [50156], [50164].

Props peterwilsoncc.
Fixes #52566.

git-svn-id: https://develop.svn.wordpress.org/trunk@50393 602fd350-edb4-49c9-b593-d223f7449a82
2021-02-20 09:53:48 +00:00
Peter Wilson
a6e1d392f2 Docs, Tests: Correctly capitalize JavaScript.
Correct Javascript to JavaScript within Wordpress core ;)

See #51800, #51802.



git-svn-id: https://develop.svn.wordpress.org/trunk@49758 602fd350-edb4-49c9-b593-d223f7449a82
2020-12-06 02:19:56 +00:00
John Blackbourn
81a12a7bec Docs: Another pass at some inline docs fixes mostly made by PHPCBF.
See #49572, #50744

git-svn-id: https://develop.svn.wordpress.org/trunk@48590 602fd350-edb4-49c9-b593-d223f7449a82
2020-07-23 21:09:04 +00:00
Sergey Biryukov
9c04110b46 Script Loader: Include the script or style handle in _wp_scripts_maybe_doing_it_wrong() message.
This makes the message more helpful and allows for easier debugging.

Props janthiel.
Fixes #50406.

git-svn-id: https://develop.svn.wordpress.org/trunk@48070 602fd350-edb4-49c9-b593-d223f7449a82
2020-06-17 10:14:36 +00:00
Sergey Biryukov
0b4e2c4604 Coding Standards: Use strict type check for in_array() and array_search() where strings are involved.
This reduces the number of `WordPress.PHP.StrictInArray.MissingTrueStrict` issues from 486 to 50.

Includes minor code layout fixes for better readability.

See #49542.

git-svn-id: https://develop.svn.wordpress.org/trunk@47550 602fd350-edb4-49c9-b593-d223f7449a82
2020-04-05 03:00:44 +00:00
Sergey Biryukov
cfc3b57488 Docs: Improve inline comments per the documentation standards.
Includes minor code layout fixes for better readability.

See #48303.

git-svn-id: https://develop.svn.wordpress.org/trunk@47122 602fd350-edb4-49c9-b593-d223f7449a82
2020-01-29 00:43:23 +00:00
John Blackbourn
db4f746b4a Docs: Improve documentation of known return types, plus other docs fixes.
See #48303


git-svn-id: https://develop.svn.wordpress.org/trunk@46660 602fd350-edb4-49c9-b593-d223f7449a82
2019-11-05 21:21:46 +00:00
John Blackbourn
e07cf22fd0 Docs: Switch to typed array notation for the docs for asset dependency functions.
Props marekdedic

See #48303


git-svn-id: https://develop.svn.wordpress.org/trunk@46595 602fd350-edb4-49c9-b593-d223f7449a82
2019-10-26 21:00:08 +00:00
Peter Wilson
61f86f6986 Docs: Fix typo in wp_print_scripts()' reference to WP_Scripts::do_item().
Fixes #48141.


git-svn-id: https://develop.svn.wordpress.org/trunk@46311 602fd350-edb4-49c9-b593-d223f7449a82
2019-09-25 22:22:40 +00:00
Sergey Biryukov
00b03f2a6f I18N: Capitalize translator comments consistently, add trailing punctuation.
Includes minor code layout fixes.

See #44360.

git-svn-id: https://develop.svn.wordpress.org/trunk@45932 602fd350-edb4-49c9-b593-d223f7449a82
2019-09-03 00:39:13 +00:00
Sergey Biryukov
ee3324653a Docs: Fix incorrect @see notation in wp_localize_script() DocBlock.
Props coffee2code, shamim51.
Fixes #47104.

git-svn-id: https://develop.svn.wordpress.org/trunk@45392 602fd350-edb4-49c9-b593-d223f7449a82
2019-05-24 01:01:05 +00:00
Dominik Schilling (ocean90)
8cf4e9ce6a I18N: Make domain argument optional in wp_set_script_translations() / WP_Scripts::set_translations().
Props swissspidy.
Fixes #45489.

git-svn-id: https://develop.svn.wordpress.org/trunk@44395 602fd350-edb4-49c9-b593-d223f7449a82
2019-01-04 21:11:01 +00:00
Sergey Biryukov
36f615eac6 Docs: Fix typo in wp_add_inline_script() and wp_add_inline_style() description.
Props jankimoradiya.
Fixes #45705.

git-svn-id: https://develop.svn.wordpress.org/trunk@44350 602fd350-edb4-49c9-b593-d223f7449a82
2018-12-20 02:41:47 +00:00
Drew Jaynes
f1abdd8f74 Docs: Fix an @see reference to use the correct class name in the wp_script_add_data() DocBlock.
Props joyously.
See #42505.


git-svn-id: https://develop.svn.wordpress.org/trunk@44332 602fd350-edb4-49c9-b593-d223f7449a82
2018-12-19 16:28:05 +00:00
Gary Pendergast
8d897837aa I18N: Add JavaScript translation support.
Adds the `wp_set_script_translations()` function which registers translations for a JavaScript file. This function takes a handle, domain and optionally a path and ensures JavaScript translation files are loaded if they exist.

Merges [43825,43828,43859,43898] from the 5.0 branch to trunk.

Props herregroen, atimmer, omarreiss, nerrad, swissspidy, ocean90, georgestephanis.
Fixes #45103, #45256.



git-svn-id: https://develop.svn.wordpress.org/trunk@44169 602fd350-edb4-49c9-b593-d223f7449a82
2018-12-14 05:51:31 +00:00
Sergey Biryukov
a2017354e2 Docs: Document that the $src parameter of WP_Dependencies::add() can be boolean.
Props dimadin.
Fixes #45009.

git-svn-id: https://develop.svn.wordpress.org/trunk@43661 602fd350-edb4-49c9-b593-d223f7449a82
2018-09-28 21:50:45 +00:00
Gary Pendergast
a75d153eee Coding Standards: Upgrade WPCS to 1.0.0
WPCS 1.0.0 includes a bunch of new auto-fixers, which drops the number of coding standards issues across WordPress significantly. Prior to running the auto-fixers, there were 15,312 issues detected. With this commit, we now drop to 4,769 issues.

This change includes three notable additions:
- Multiline function calls must now put each parameter on a new line.
- Auto-formatting files is now part of the `grunt precommit` script. 
- Auto-fixable coding standards issues will now cause Travis failures.

Fixes #44600.



git-svn-id: https://develop.svn.wordpress.org/trunk@43571 602fd350-edb4-49c9-b593-d223f7449a82
2018-08-17 01:50:26 +00:00
Dominik Schilling (ocean90)
8df8cf2df1 Pinking shears.
See #41057.

git-svn-id: https://develop.svn.wordpress.org/trunk@42843 602fd350-edb4-49c9-b593-d223f7449a82
2018-03-18 14:22:09 +00:00
Drew Jaynes
1b46470b75 Docs: Link to the "Conditional Tags" article in the Theme Developer Handbook from the descriptions for a variety of core conditional tag functions.
These notations largely serve to direct consumers (of both the source and the parsed code reference) to extended information on individual and related conditional tags throughout WordPress. The changeset also standardizes corresponding DocBlock summaries to use third-person singular verbs.

Notations been added for the following functions:

* comments_open()
* email exists()
* has_excerpt()
* has_post_thumbnail()
* has_tag()
* in_category()
* in_the_loop()
* is_404()
* is_active_sidebar()
* is_active_widget()
* is_admin()
* is_admin_bar_showing()
* is_archive()
* is_attachment()
* is_author()
* is_blog_installed()
* is_category()
* is_comments_popup()
* is_date()
* is_day()
* is_dynamic_sidebar()
* is_feed()
* is_front_page()
* is_home()
* is_local_attachment()
* is_main_query
* is_month()
* is_multi_author
* is_new_day()
* is_page()
* is_page_template()
* is_paged()
* is_plugin_active()
* is_plugin_active_for_network()
* is_plugin_inactive()
* is_plugin_page()
* is_post_type_archive()
* is_preview()
* is_rtl()
* is_search()
* is_single()
* is_singular()
* is_sticky()
* is_tag()
* is_tax()
* is_taxonomy_hierarchical()
* is_time()
* is_trackback()
* is_user_logged_in()
* is_year()
* pings_open()
* post_type_exists()
* taxonomy_exists()
* term_exists()
* username exists()
* wp_attachment_is_image()
* wp_script_is()

Props janalwin.
Fixes #43254.


git-svn-id: https://develop.svn.wordpress.org/trunk@42710 602fd350-edb4-49c9-b593-d223f7449a82
2018-02-13 16:53:44 +00:00
Gary Pendergast
8f95800d52 Code is Poetry.
WordPress' code just... wasn't.
This is now dealt with.

Props jrf, pento, netweb, GaryJ, jdgrimes, westonruter, Greg Sherwood from PHPCS, and everyone who's ever contributed to WPCS and PHPCS.
Fixes #41057.



git-svn-id: https://develop.svn.wordpress.org/trunk@42343 602fd350-edb4-49c9-b593-d223f7449a82
2017-11-30 23:09:33 +00:00
Weston Ruter
83b059aa19 Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.

See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/

Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.


git-svn-id: https://develop.svn.wordpress.org/trunk@38810 602fd350-edb4-49c9-b593-d223f7449a82
2016-10-18 20:04:36 +00:00
Sergey Biryukov
669ec7953e Script Loader: Correct default value for $src in wp_enqueue_script() and wp_enqueue_style().
Props Frank Klein for initial patch.
See #37770.

git-svn-id: https://develop.svn.wordpress.org/trunk@38519 602fd350-edb4-49c9-b593-d223f7449a82
2016-09-04 04:08:11 +00:00
Sergey Biryukov
80439d1c48 I18N: Add translator comments for strings in wp-includes/functions.wp-scripts.php.
Props ramiy.
Fixes #37803.

git-svn-id: https://develop.svn.wordpress.org/trunk@38345 602fd350-edb4-49c9-b593-d223f7449a82
2016-08-23 23:52:31 +00:00
Sergey Biryukov
920f29616a Docs: Use 3-digit, x.x.x-style semantic versioning for _doing_it_wrong(), _deprecated_function(), _deprecated_argument(), and _deprecated_file() throughout core.
Props metodiew.
Fixes #36495.

git-svn-id: https://develop.svn.wordpress.org/trunk@37985 602fd350-edb4-49c9-b593-d223f7449a82
2016-07-06 12:39:01 +00:00
Drew Jaynes
194583a770 Docs: Apply inline @see tags to hooks referenced in DocBlocks in a variety of wp-includes/* files.
Applying these specially-crafted `@see` tags allows the Code Reference parser to recognize and link these elements as actions and filters.

See #36921.


git-svn-id: https://develop.svn.wordpress.org/trunk@37543 602fd350-edb4-49c9-b593-d223f7449a82
2016-05-23 19:00:41 +00:00
Sergey Biryukov
1af1c2d30f I18N: Update translator comments after [37190].
See #36496.

git-svn-id: https://develop.svn.wordpress.org/trunk@37191 602fd350-edb4-49c9-b593-d223f7449a82
2016-04-13 04:29:25 +00:00
Sergey Biryukov
8594b7922d I18N: After [37188], display script and style tags in the message as <script> and <style>.
Props dd32.
See #36496.

git-svn-id: https://develop.svn.wordpress.org/trunk@37190 602fd350-edb4-49c9-b593-d223f7449a82
2016-04-13 04:15:40 +00:00
Sergey Biryukov
c1913d5ad3 I18N: Remove tag and function names from two translatable strings.
Add translator comments.

Props andg for initial patch.
Fixes #36496.

git-svn-id: https://develop.svn.wordpress.org/trunk@37188 602fd350-edb4-49c9-b593-d223f7449a82
2016-04-13 03:01:56 +00:00
John Blackbourn
97c7cff31f 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
2016-03-14 22:36:26 +00:00
Dominik Schilling (ocean90)
592da58d26 Docs: Improve inline docs for WP_Dependencies, WP_Styles, and WP_Scripts.
Also, make them and related files part of WordPress.

See #35964.

git-svn-id: https://develop.svn.wordpress.org/trunk@36744 602fd350-edb4-49c9-b593-d223f7449a82
2016-02-27 20:33:57 +00:00
Dominik Schilling (ocean90)
276635f8a3 Docs: Use correct @since tags for script enqueue functions.
See [4968], [3788].
See #35964.

git-svn-id: https://develop.svn.wordpress.org/trunk@36729 602fd350-edb4-49c9-b593-d223f7449a82
2016-02-26 12:49:37 +00:00
Dominik Schilling (ocean90)
9a7488aaf8 Spelling: Standardize on "front end"/"back end" (noun) and "front-end"/"back-end" (adjective).
Props obrienlabs, thewanderingbrit.
Fixes #34887.

git-svn-id: https://develop.svn.wordpress.org/trunk@36709 602fd350-edb4-49c9-b593-d223f7449a82
2016-02-25 12:52:33 +00:00
Drew Jaynes
eaaef09d83 Docs: Use a third-person singular verb in the DocBlock summary for wp_add_inline_script(), introduced in [36633].
See #14853. See #32246.


git-svn-id: https://develop.svn.wordpress.org/trunk@36707 602fd350-edb4-49c9-b593-d223f7449a82
2016-02-25 05:13:14 +00:00
Pascal Birchler
0e13a57288 Script Loader: Introduce wp_add_inline_script().
This new function can be used to add inline JavaScript before and after enqueued scripts, just like `wp_add_inline_style()` works for CSS.

Props atimmer, abiralneupane, ocean90, swissspidy.
Fixes #14853.

git-svn-id: https://develop.svn.wordpress.org/trunk@36633 602fd350-edb4-49c9-b593-d223f7449a82
2016-02-23 16:43:41 +00:00
John Blackbourn
858cf7d215 Docs: Miscellaneous docblock code quality tweaks.
See #32246


git-svn-id: https://develop.svn.wordpress.org/trunk@36074 602fd350-edb4-49c9-b593-d223f7449a82
2015-12-23 07:52:04 +00:00
Konstantin Kovshenin
318455ff24 Docs: Remove some more dittography.
See #34885, r35793.


git-svn-id: https://develop.svn.wordpress.org/trunk@35796 602fd350-edb4-49c9-b593-d223f7449a82
2015-12-06 21:49:43 +00:00
Scott Taylor
c7c55f20b5 After [32596] and [32597], ensure that wp_scripts|styles() is called to ensure an instance is created of WP_Scripts|Styles() before calling ->do_items().
See #32444.


git-svn-id: https://develop.svn.wordpress.org/trunk@32728 602fd350-edb4-49c9-b593-d223f7449a82
2015-06-12 16:53:17 +00:00
Scott Taylor
bc164ef635 Cleanup the use of $wp_scripts global in functions.wp-scripts.php.
See #32444.


git-svn-id: https://develop.svn.wordpress.org/trunk@32596 602fd350-edb4-49c9-b593-d223f7449a82
2015-05-25 16:23:46 +00:00
John Blackbourn
39639c79da Add a return value to wp_register_script() and wp_register_style() which matches the return value of WP_Dependencies::add().
Props katzwebdesign, pareshradadiya, DrewAPicture.

Fixes #31126


git-svn-id: https://develop.svn.wordpress.org/trunk@32483 602fd350-edb4-49c9-b593-d223f7449a82
2015-05-10 19:56:15 +00:00
Scott Taylor
fbdbba9e01 Revert [31030] and [31033]. Incidentally, there is no lazy-loading happening here anyway.
Pushing #26111 to future.


git-svn-id: https://develop.svn.wordpress.org/trunk@32124 602fd350-edb4-49c9-b593-d223f7449a82
2015-04-14 15:12:49 +00:00
Drew Jaynes
5be0ba0ae8 Add a variety of missing descriptions and fix syntax for wp_scripts(), _wp_scripts_maybe_doing_it_wrong(), and wp_script_add_data().
See #31888.


git-svn-id: https://develop.svn.wordpress.org/trunk@32040 602fd350-edb4-49c9-b593-d223f7449a82
2015-04-05 15:54:08 +00:00
Dominik Schilling (ocean90)
135be2826d Avoid a PHP notice in wp_enqueue_script() if $handle is an array.
Calling `wp_enqueue_script()` with an array as the first argument is a "hidden feature" and should be avoided. Use dependencies instead.

props sorich87 for initial patch.
fixes #31636.
see #14488.

git-svn-id: https://develop.svn.wordpress.org/trunk@31887 602fd350-edb4-49c9-b593-d223f7449a82
2015-03-25 17:54:50 +00:00
Andrew Ozz
f18854e866 Add support for IE conditional comments for WP_Scripts to match the functionality of WP_Styles, including unit tests. Props filosofo, aaroncampbell, ethitter, georgestephanis, valendesigns. Fixes #16024.
git-svn-id: https://develop.svn.wordpress.org/trunk@31223 602fd350-edb4-49c9-b593-d223f7449a82
2015-01-17 01:36:55 +00:00
Scott Taylor
7c707c6633 Add @ignore to _wp_scripts_maybe_doing_it_wrong().
Props DrewAPicture for the thought leadership.
See #20513.


git-svn-id: https://develop.svn.wordpress.org/trunk@31202 602fd350-edb4-49c9-b593-d223f7449a82
2015-01-16 05:37:06 +00:00