Related Posts: add docblock to existing filter#8359
Related Posts: add docblock to existing filter#8359oskosk merged 2 commits intoAutomattic:masterfrom Umangvaghela:add-comment-in-apply-filter
Conversation
jeherve
left a comment
There was a problem hiding this comment.
Here are a few things you can do to make the filter easier to understand and use.
| } | ||
|
|
||
| /** | ||
| * Filter that is used to customize related posts option. |
There was a problem hiding this comment.
Could you clarify things a bit here? The filter allows you to change the options used to display Related Posts in the Customizer. I think this explains things a bit more.
| * Filter that is used to customize related posts option. | ||
| * | ||
| * @since 4.4.0 | ||
| * |
There was a problem hiding this comment.
Could you add @module related-posts here?
| * | ||
| * @since 4.4.0 | ||
| * | ||
| * @param mixed array post customize option. |
There was a problem hiding this comment.
This should always be an array, so I would remove "mixed". I would also add the array variable, like so:
@param array $options Array of options used to display Related Posts in the Customizer.
|
Hello Sir,I update changes which suggested you. So please check it and provide your feedback if i miss something. Thanks |
oskosk
left a comment
There was a problem hiding this comment.
LGTM!
Thanks for the changes @Umangvaghela !
Changes proposed in this Pull Request:
Testing instructions:
Proposed changelog entry for your changes: