Docs: Clarify add_editor_style() applies to both TinyMCE and block editor#8783
Docs: Clarify add_editor_style() applies to both TinyMCE and block editor#8783Sourav61 wants to merge 3 commits intoWordPress:trunkfrom
Conversation
|
Hi @Sourav61! 👋 Thank you for your contribution to WordPress! 💖 It looks like this is your first pull request to No one monitors this repository for new pull requests. Pull requests must be attached to a Trac ticket to be considered for inclusion in WordPress Core. To attach a pull request to a Trac ticket, please include the ticket's full URL in your pull request description. Pull requests are never merged on GitHub. The WordPress codebase continues to be managed through the SVN repository that this GitHub repository mirrors. Please feel free to open pull requests to work on any contribution you are making. More information about how GitHub pull requests can be used to contribute to WordPress can be found in the Core Handbook. Please include automated tests. Including tests in your pull request is one way to help your patch be considered faster. To learn about WordPress' test suites, visit the Automated Testing page in the handbook. If you have not had a chance, please review the Contribute with Code page in the WordPress Core Handbook. The Developer Hub also documents the various coding standards that are followed:
Thank you, |
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the Core Committers: Use this line as a base for the props when committing in SVN: To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
Test using WordPress PlaygroundThe changes in this pull request can previewed and tested using a WordPress Playground instance. WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser. Some things to be aware of
For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation. |
dilipbheda
left a comment
dilipbheda
left a comment
There was a problem hiding this comment.
@Sourav61 we can improve the inline document like following changes:
diff --git a/src/wp-includes/theme.php b/src/wp-includes/theme.php
index b4a71d855a..252b1f8b37 100644
--- a/src/wp-includes/theme.php
+++ b/src/wp-includes/theme.php
@@ -2158,14 +2158,15 @@ function wp_update_custom_css_post( $css, $args = array() ) {
}
/**
- * Adds callback for custom TinyMCE editor stylesheets.
+ * Adds callback for editor stylesheets.
*
- * The parameter $stylesheet is the name of the stylesheet, relative to
- * the theme root. It also accepts an array of stylesheets.
- * It is optional and defaults to 'editor-style.css'.
+ * This function allows you to add custom stylesheets to the editor.
+ * It works for both the classic editor (TinyMCE) and the block editor (Gutenberg).
+ * The parameter $stylesheet can accept a single stylesheet filename (relative to the theme root),
+ * or an array of stylesheets. If no parameter is provided, the default 'editor-style.css' is used.
*
* This function automatically adds another stylesheet with -rtl prefix, e.g. editor-style-rtl.css.
- * If that file doesn't exist, it is removed before adding the stylesheet(s) to TinyMCE.
+ * If that file doesn't exist, it is removed before adding the stylesheet(s) to editor.
* If an array of stylesheets is passed to add_editor_style(),
* RTL is only added for the first stylesheet.
*
@@ -2177,7 +2178,7 @@ function wp_update_custom_css_post( $css, $args = array() ) {
* @global array $editor_styles
*
* @param array|string $stylesheet Optional. Stylesheet name or array thereof, relative to theme root.
- * Defaults to 'editor-style.css'
+ * Defaults to 'editor-style.css'.
*/
function add_editor_style( $stylesheet = 'editor-style.css' ) {
global $editor_styles;
2 participants
Docs: Clarify add_editor_style() applies to both TinyMCE and block editor
Trac ticket: https://core.trac.wordpress.org/ticket/63411
This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.