Commit Graph

105 Commits

Author SHA1 Message Date
Drew Jaynes
188e47869f Ensure inline code is markdown-escaped as such, HTML tags are removed from summaries, and that code snippets in descriptions are properly indented.
Affects DocBlocks for the following core elements:
* Markdown-indent a code snippet in the description for `wp_salt()`
* Backtick-escape inline code in the return description for `get_avatar()`
* Various markdown formatting in the description for `add_filter()`
* Markdown-indent a code snippet in the description for `apply_filters()`
* Backtick-escape inline code in the `@see` description for `apply_filters_ref_array()`
* Backtick-escape inline code in the description for `do_action()`
* Backtick-escape variables in the parameter and return descriptions for `do_action_ref_array()`
* Various markdown formatting in the description for `get_plugin_data()`

Props rarst.
See #30473.

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


git-svn-id: http://core.svn.wordpress.org/trunk@30533 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-11-24 06:05:23 +00:00
Drew Jaynes
f8657d5890 Remove redundant and erroneous @uses tag from most core inline documentation.
Per our inline documentation standards, no further use of the `@uses` tag is recommended as used and used-by relationships can be derived through other means. This removes most uses of the tag in core documentation, with remaining tags to be converted to `@global` or `@see` as they apply.

Fixes #30191.

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


git-svn-id: http://core.svn.wordpress.org/trunk@30105 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-10-30 01:05:24 +00:00
Mark Jaquith
e1f2b3b9e2 Use HTTPS URLs for trac.wordpress.org (and use core.trac.wordpress.org)
see #27115
Built from https://develop.svn.wordpress.org/trunk@29789


git-svn-id: http://core.svn.wordpress.org/trunk@29561 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-09-29 13:37:16 +00:00
Andrew Nacin
b5f0a32baa Unit tests for has_filter() not resetting the array pointer.
props pento.
fixes #29070. see [29472].

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


git-svn-id: http://core.svn.wordpress.org/trunk@29439 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-09-02 06:50:15 +00:00
Scott Taylor
d45cde548e After [29422], make sure the internal array counter is not reset for the $wp_filter global.
Props kovshenin.
See #29070.

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


git-svn-id: http://core.svn.wordpress.org/trunk@29250 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-08-12 14:47:17 +00:00
Scott Taylor
8f73ec76d1 After [28883], ensure that priorities have callbacks before returning true in has_filter().
Adds unit tests.

Props boonebgorges.
Fixes #29070.

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


git-svn-id: http://core.svn.wordpress.org/trunk@29200 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-08-07 02:30:20 +00:00
Drew Jaynes
e7f7fcbab8 General phpDoc fixes in wp-includes/plugin.php.
See #28516.

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


git-svn-id: http://core.svn.wordpress.org/trunk@28690 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-06-29 09:19:15 +00:00
Sergey Biryukov
341eca6024 List the expected @param type first.
see #28516.
Built from https://develop.svn.wordpress.org/trunk@28889


git-svn-id: http://core.svn.wordpress.org/trunk@28688 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-06-29 08:47:14 +00:00
Sergey Biryukov
7bb7693dd1 More tweaks to @param docs in wp-includes/plugin.php.
see #28516.
Built from https://develop.svn.wordpress.org/trunk@28888


git-svn-id: http://core.svn.wordpress.org/trunk@28687 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-06-29 08:42:16 +00:00
Scott Taylor
62075239b8 Update @param docs in plugin.php
Props dkotter.
Fixes #28516.

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


git-svn-id: http://core.svn.wordpress.org/trunk@28685 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-06-28 04:50:15 +00:00
Scott Taylor
0289b98648 After [28883], remove_filter() should set $GLOBALS['wp_filter'][ $tag ] to array() when empty.
Props wonderboymusic, sphoid.
Fixes #28142.

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


git-svn-id: http://core.svn.wordpress.org/trunk@28683 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-06-28 04:38:15 +00:00
Scott Taylor
9275c87190 remove_all_filters() should set to array(), not call unset().
Props nacin, c3mdigital.
Fixes #19306.

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


git-svn-id: http://core.svn.wordpress.org/trunk@28682 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-06-28 04:27:15 +00:00
Drew Jaynes
320b3751a3 Add a missing @since 3.9.0 to the PHPDoc for wp_register_plugin_realpath().
See #16953, #27700.

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


git-svn-id: http://core.svn.wordpress.org/trunk@27841 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-04-07 21:34:14 +00:00
Drew Jaynes
4ed628a7c6 Improve inline documentation for functionality in wp-includes/plugin.php added in 3.9.
See #14994, #27700.

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


git-svn-id: http://core.svn.wordpress.org/trunk@27840 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-04-07 21:30:14 +00:00
Andrew Nacin
0b5729216d Don't try to resolve symlinks for single-file plugins. plugins_url() should not be used in this context anyway.
props rmccue.
fixes #16953.

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


git-svn-id: http://core.svn.wordpress.org/trunk@27829 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-04-07 20:15:15 +00:00
Andrew Nacin
076077383d Introduce doing_filter() and doing_action() to identify hooks in progress.
did_action() returns true the moment a hook is initially run, leaving you no way to tell if the hook is still in progress. Hooks can be nested and this checks the entire stack, versus current_filter() which only identifies the final hook in the stack. This commit also introduces current_action() for parity.

To tell if a hook has completed, one can use did_action() and ! doing_action() together.

The functions do not require an argument. In that situation, they indicate whether the stack is empty.

props ericmann for the initial unit tests.
fixes #14994.

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


git-svn-id: http://core.svn.wordpress.org/trunk@27150 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-02-26 18:44:14 +00:00
Drew Jaynes
cb8951b0b3 Remove all @package and @subpackage PHPDoc tags not at the file- or class-levels in core.
See #27200.

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


git-svn-id: http://core.svn.wordpress.org/trunk@27119 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-02-25 17:14:14 +00:00
Andrew Nacin
5f0981788d Detect and handle symlinking of plugins in plugin_basename().
props rmccue, MikeSchinkel, jdgrimes.
see #16953.

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


git-svn-id: http://core.svn.wordpress.org/trunk@27024 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-02-10 23:00:15 +00:00
Drew Jaynes
cd8cedc40d First there were two, and now there are three -- in the @since versions that came before and that shall be. And so it will be, says nacin.
Props JustinSainton, SergeyBiryukov, DrewAPicture.
Fixes #26713.

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


git-svn-id: http://core.svn.wordpress.org/trunk@26754 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-12-24 18:57:12 +00:00
Andrew Nacin
9dcd0110fb Initialize the filter globals.
props rmccue.
fixes #25378.

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


git-svn-id: http://core.svn.wordpress.org/trunk@25524 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-09-24 19:05:10 +00:00
Peter Westwood
c663f0a925 Clean up the documentation for add_filter and apply_filters.
Fixes #19203 props DrewAPicture, ericlewis

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


git-svn-id: http://core.svn.wordpress.org/trunk@25397 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-09-18 07:48:10 +00:00
Andrew Nacin
bb4cc55ccf Close an HTML tag inside the add_filter() inline doc. props johnbillion, fixes #24772.
git-svn-id: http://core.svn.wordpress.org/trunk@24711 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-07-16 13:59:43 +00:00
Andrew Nacin
16f4954b3b Add a delimiter to _wp_filter_build_unique_id()'s handling of static method callbacks. props scribu, fixes #23265.
git-svn-id: http://core.svn.wordpress.org/trunk@24251 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-05-14 15:55:21 +00:00
Sergey Biryukov
ed6941a0f4 Fix several copy/paste errors in register_deactivation_hook() description. props Caspie. fixes #24097.
git-svn-id: http://core.svn.wordpress.org/trunk@23999 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-04-16 09:53:02 +00:00
Helen Hou-Sandí
4e7abbf87b Correct phpdoc for wp-includes/plugin.php: wp-content/plugins/, not wp-content/plugin/. props technosailor. fixes #23024.
git-svn-id: http://core.svn.wordpress.org/trunk@23190 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-12-20 15:49:55 +00:00
nacin
a530304b68 Revert [21287] until #21169 goes through. see #21321.
git-svn-id: http://core.svn.wordpress.org/trunk@21299 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-07-21 20:24:21 +00:00
nacin
ff2d1c5195 Clarify the return value of has_filter() and has_action(). It returns a boolean if only the first argument is specified. If the second argument is specified, it returns false or an integer, which means it may return a non-boolean value that evaluates to false (so, 0), so you should take care to use the === operator.
Correct the function definition of remove_filter() and remove_action(), which 'accepted' an $accepted_args argument, but did not require or use it.

fixes #19417.



git-svn-id: http://core.svn.wordpress.org/trunk@21288 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-07-20 13:54:42 +00:00
nacin
70da9092d4 Remove unnecessary is_null() checks from the worker loops inside do_action(), apply_filters(), etc. fixes #21321. see #21169.
git-svn-id: http://core.svn.wordpress.org/trunk@21287 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-07-20 05:25:37 +00:00
ryan
e3b46b25d3 Lose EOF ?>. Clean up EOF newlines. fixes #12307
git-svn-id: http://svn.automattic.com/wordpress/trunk@19712 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-01-08 17:01:11 +00:00
ryan
616c35e71c One newline is enough.
git-svn-id: http://svn.automattic.com/wordpress/trunk@19684 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-01-05 20:10:39 +00:00
ryan
07ff8b216b Use one space, not two, after trailing punctuation. fixes #19537
git-svn-id: http://svn.automattic.com/wordpress/trunk@19593 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2011-12-13 23:45:31 +00:00
nacin
75c741cd8b Revert other stuffs from [19374].
git-svn-id: http://svn.automattic.com/wordpress/trunk@19376 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2011-11-21 15:43:57 +00:00
nacin
5e69bd0caf Set $parent_file for post-new.php when show_in_menu is a file. Provides for correct top-level highlighting. $submenu_file remains set to expect a post-new.php menu. see #19125.
git-svn-id: http://svn.automattic.com/wordpress/trunk@19374 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2011-11-21 15:35:57 +00:00
duck_
2f51b9be0d Fix typos in documentation (wp-includes/[i-z]). See #18560.
git-svn-id: http://svn.automattic.com/wordpress/trunk@18639 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2011-09-05 19:08:15 +00:00
ryan
b136c576ed Grammar fix. Props lukeschlather, markmcwilliams. fixes #17315
git-svn-id: http://svn.automattic.com/wordpress/trunk@18507 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2011-08-04 16:03:53 +00:00
ryan
3e77cd18c9 Avoid array push/pops for empty filters and actions. fixes #17110
git-svn-id: http://svn.automattic.com/wordpress/trunk@17638 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2011-04-14 18:05:30 +00:00
nacin
c9e1ab9bd9 _doing_it_wrong takes three arguments. fixes #15824.
git-svn-id: http://svn.automattic.com/wordpress/trunk@16955 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2010-12-15 17:14:25 +00:00
westi
167df97e81 Switch to _doing_it_wrong(). See #15824
git-svn-id: http://svn.automattic.com/wordpress/trunk@16940 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2010-12-15 11:31:00 +00:00
markjaquith
14be097d5e Revert [15829] for now, consider better solution for 3.2. see #13550
git-svn-id: http://svn.automattic.com/wordpress/trunk@16575 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2010-11-24 20:25:26 +00:00
nacin
f6d1e9c634 Only a static class method or function can be used in an uninstall hook. props scribu, fixes #13786.
git-svn-id: http://svn.automattic.com/wordpress/trunk@16339 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2010-11-13 09:45:57 +00:00
scribu
af29ce4440 Apply filter in plugin_basename(). Props vladimir_kolesnikov. Fixes #13550
git-svn-id: http://svn.automattic.com/wordpress/trunk@15829 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2010-10-17 13:47:40 +00:00
nacin
5a20c05d27 Phpdoc argument/@param cleanups. props duck_, see #14783.
git-svn-id: http://svn.automattic.com/wordpress/trunk@15590 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2010-09-07 11:21:11 +00:00
ryan
1a552dd029 Strip trailing whitespace
git-svn-id: http://svn.automattic.com/wordpress/trunk@14924 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2010-05-26 02:42:15 +00:00
westi
3a3cce834a Fix remaining notice when using closures. Fixes #10493 props scribu.
git-svn-id: http://svn.automattic.com/wordpress/trunk@14691 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2010-05-16 13:41:02 +00:00
westi
86cb0aa6b9 Fix notices/usage of closures as action/filter handlers. Fixes #10493 based on patch from scribu.
git-svn-id: http://svn.automattic.com/wordpress/trunk@14690 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2010-05-16 08:10:39 +00:00
westi
c3a6bea231 Ensure that apply_filters_ref_array passes the result of the filter to the next filter. Fixes #12723 props scribue.
git-svn-id: http://svn.automattic.com/wordpress/trunk@13906 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2010-03-31 21:39:18 +00:00
nacin
a7feaed0e6 Change @since 3.0 to @since 3.0.0.
git-svn-id: http://svn.automattic.com/wordpress/trunk@13827 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2010-03-26 19:13:36 +00:00
westi
5bce147d90 Introduce apply_filters_ref_array(). See #9886 props scribu.
git-svn-id: http://svn.automattic.com/wordpress/trunk@13756 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2010-03-18 21:24:07 +00:00
westi
c71c407fd2 Fix a possible undefined offset warning in do_action. Fixes #11241 props chrisbliss18.
git-svn-id: http://svn.automattic.com/wordpress/trunk@13674 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2010-03-11 21:58:17 +00:00
nacin
8dee46ddf0 Fix typo in remove_all_filters() that prevented hooks from being removed by priority. fixes #12492, props chrisbliss18.
git-svn-id: http://svn.automattic.com/wordpress/trunk@13567 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2010-03-03 06:41:19 +00:00