Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Style engine: update docs for css_var #5255

Closed
wants to merge 2 commits into from
Closed

Style engine: update docs for css_var #5255

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
82164ab
The doc comments for css_var were topsy turvy.
ramonjd Sep 20, 2023
46acddf
Spaces between comment lines
ramonjd Sep 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 15 additions & 20 deletions src/wp-includes/style-engine/class-wp-style-engine.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,26 +26,21 @@
#[AllowDynamicProperties]
final class WP_Style_Engine {
/**
* Style definitions that contain the instructions to
* parse/output valid Gutenberg styles from a block's attributes.
*
* For every style definition, the following properties are valid:
*
* - classnames => (array) An array of classnames to be returned for block styles.
* The key is a classname or pattern.
* A value of `true` means the classname should be applied always.
* Otherwise, a valid CSS property (string) to match the incoming value,
* e.g. "color" to match var:preset|color|somePresetSlug.
* - css_vars => (array) An array of key value pairs used to generate CSS var values.
* The key is a CSS var pattern, whose `$slug` fragment will be replaced with a preset slug.
* The value should be a valid CSS property (string) to match the incoming value,
* e.g. "color" to match var:preset|color|somePresetSlug.
* - property_keys => (array) An array of keys whose values represent a valid CSS property,
* e.g. "margin" or "border".
* - path => (array) A path that accesses the corresponding style value in the block style object.
* - value_func => (string) The name of a function to generate a CSS definition array
* for a particular style object. The output of this function should be
* `array( "$property" => "$value", ... )`.
* Style definitions that contain the instructions to parse/output valid Gutenberg styles from a block's attributes.
*
* For every style definition, the follow properties are valid:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not a native English speaker but "the following properties" seems to be the correct (or at least more consistent) form here.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're right. Thanks for picking up on that. I blindly copied and pasted.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like it's been committed. I can create a new PR since it's an embarrassing spelling error (for me).

Changeset: #5256

*
* - classnames => (array) an array of classnames to be returned for block styles. The key is a classname or pattern.
* A value of `true` means the classname should be applied always. Otherwise, a valid CSS property (string)
* to match the incoming value, e.g., "color" to match var:preset|color|somePresetSlug.
* - css_vars => (array) an array of key value pairs used to generate CSS var values.
* The key should be the CSS property name that matches the second element of the preset string value,
* i.e., "color" in var:preset|color|somePresetSlug. The value is a CSS var pattern (e.g. `--wp--preset--color--$slug`),
* whose `$slug` fragment will be replaced with the preset slug, which is the third element of the preset string value,
* i.e., `somePresetSlug` in var:preset|color|somePresetSlug.
* - property_keys => (array) array of keys whose values represent a valid CSS property, e.g., "margin" or "border".
* - path => (array) a path that accesses the corresponding style value in the block style object.
* - value_func => (string) the name of a function to generate a CSS definition array for a particular style object. The output of this function should be `array( "$property" => "$value", ... )`.
*
* @since 6.1.0
* @var array
Expand Down