diff --git a/assets/js/instant-results/admin/components/facet-selector.js b/assets/js/instant-results/admin/components/facet-selector.js index 026d80eb11..9a8d013634 100644 --- a/assets/js/instant-results/admin/components/facet-selector.js +++ b/assets/js/instant-results/admin/components/facet-selector.js @@ -13,7 +13,7 @@ import { facets } from '../config'; /** * Facet selector component. * - * @param {Object} props Props. + * @param {Object} props Props. * @param {string} props.defaultValue Default value. * @return {WPElement} Element. */ diff --git a/assets/js/instant-results/components/common/checkbox-list.js b/assets/js/instant-results/components/common/checkbox-list.js index 6eecb38412..374416017f 100644 --- a/assets/js/instant-results/components/common/checkbox-list.js +++ b/assets/js/instant-results/components/common/checkbox-list.js @@ -14,20 +14,20 @@ import SmallButton from './small-button'; * Checkbox list component. * * @typedef {Object} Option - * @property {number} count Number associated with option. - * @property {string} id Option ID. - * @property {string} label Option label. - * @property {number} order Option order. - * @property {string} parent Parent option value. - * @property {any} value Option value. + * @property {number} count Number associated with option. + * @property {string} id Option ID. + * @property {string} label Option label. + * @property {number} order Option order. + * @property {string} parent Parent option value. + * @property {any} value Option value. * - * @param {Object} props Component props. - * @param {boolean} props.disabled Whether the checkboxes should be disabled. - * @param {boolean} props.label List label. - * @param {Function} props.onChange Checkbox change event callback function. - * @param {Option[]} props.options Checkbox options. - * @param {string} props.selected Selected values. - * @param {string} props.sortBy How to sort options. + * @param {Object} props Component props. + * @param {boolean} props.disabled Whether the checkboxes should be disabled. + * @param {boolean} props.label List label. + * @param {Function} props.onChange Checkbox change event callback function. + * @param {Option[]} props.options Checkbox options. + * @param {string} props.selected Selected values. + * @param {string} props.sortBy How to sort options. * @return {WPElement} A React element. */ export default ({ disabled, label, options, onChange, selected, sortBy }) => { @@ -44,8 +44,8 @@ export default ({ disabled, label, options, onChange, selected, sortBy }) => { /** * Reducer to group options by parent. * - * @param {Object} items Options grouped by parent. - * @param {Option} option Option details. + * @param {Object} items Options grouped by parent. + * @param {Option} option Option details. * @param {string} option.parent Option parent value. * @return {Object} Options grouped by parent. */ @@ -68,8 +68,8 @@ export default ({ disabled, label, options, onChange, selected, sortBy }) => { * Reducer to group top level options. Top level options are options * with a parent of '0' or without a parent. * - * @param {Array} items Options without a parent. - * @param {Option} option Option details. + * @param {Array} items Options without a parent. + * @param {Option} option Option details. * @param {string} option.parent Option parent value. * @return {Object} Options without a parent. */ diff --git a/assets/js/instant-results/components/common/checkbox.js b/assets/js/instant-results/components/common/checkbox.js index c9f2da6598..93f384993c 100644 --- a/assets/js/instant-results/components/common/checkbox.js +++ b/assets/js/instant-results/components/common/checkbox.js @@ -6,8 +6,8 @@ import { WPElement } from '@wordpress/element'; /** * Checkbox component. * - * @param {Option} props Component props. - * @param {string} props.id Checkbox ID. + * @param {Option} props Component props. + * @param {string} props.id Checkbox ID. * @param {string} props.label Checkbox label. * * @return {WPElement} Component element. diff --git a/assets/js/instant-results/components/common/modal.js b/assets/js/instant-results/components/common/modal.js index 179d579b57..7e7caa888f 100644 --- a/assets/js/instant-results/components/common/modal.js +++ b/assets/js/instant-results/components/common/modal.js @@ -13,11 +13,11 @@ import { __ } from '@wordpress/i18n'; /** * Modal components. * - * @param {Object} props Component props. + * @param {Object} props Component props. * @param {WPElement} props.children Component children. - * @param {boolean} props.isOpen Whether the modal is open. - * @param {Function} props.onClose Callback to run when modal is closed. - * @param {Object} ref Ref. + * @param {boolean} props.isOpen Whether the modal is open. + * @param {Function} props.onClose Callback to run when modal is closed. + * @param {Object} ref Ref. * @return {WPElement} React element. */ const Modal = ({ children, isOpen, onClose, ...props }, ref) => { diff --git a/assets/js/instant-results/components/common/panel.js b/assets/js/instant-results/components/common/panel.js index 7d80f301f1..9d9201e6c9 100644 --- a/assets/js/instant-results/components/common/panel.js +++ b/assets/js/instant-results/components/common/panel.js @@ -7,10 +7,10 @@ import { chevronDown, chevronUp, Icon } from '@wordpress/icons'; /** * Facet wrapper component. * - * @param {Object} props Component props. - * @param {WPElement} props.children Component children. - * @param {boolean} props.defaultIsOpen Whether the panel is open by default. - * @param {string} props.label Facet label. + * @param {Object} props Component props. + * @param {WPElement} props.children Component children. + * @param {boolean} props.defaultIsOpen Whether the panel is open by default. + * @param {string} props.label Facet label. * @return {WPElement} Component element. */ export default ({ children, defaultIsOpen, label }) => { diff --git a/assets/js/instant-results/components/common/small-button.js b/assets/js/instant-results/components/common/small-button.js index c870952dd5..bf83a14577 100644 --- a/assets/js/instant-results/components/common/small-button.js +++ b/assets/js/instant-results/components/common/small-button.js @@ -1,9 +1,9 @@ /** * Small button component. * - * @param {Object} props Props. - * @param {WPElement} props.children Children. - * @param {string} props.className Class attribute. + * @param {Object} props Props. + * @param {WPElement} props.children Children. + * @param {string} props.className Class attribute. * @return {WPElement} Element. */ export default ({ children, className, ...props }) => { diff --git a/assets/js/instant-results/components/common/star-rating.js b/assets/js/instant-results/components/common/star-rating.js index 6ae5bc990e..08b97ca948 100644 --- a/assets/js/instant-results/components/common/star-rating.js +++ b/assets/js/instant-results/components/common/star-rating.js @@ -6,7 +6,7 @@ import { __, sprintf } from '@wordpress/i18n'; /** * Star rating component. * - * @param {Option} props Component props. + * @param {Option} props Component props. * @param {string} props.rating Rating. * * @return {WPElement} Component element. diff --git a/assets/js/instant-results/components/facets/facet.js b/assets/js/instant-results/components/facets/facet.js index 0a9f273c32..4f284cbb9f 100644 --- a/assets/js/instant-results/components/facets/facet.js +++ b/assets/js/instant-results/components/facets/facet.js @@ -13,12 +13,12 @@ import TaxonomyTermsFacet from './taxonomy-terms-facet'; /** * Facet component. * - * @param {Object} props Props. - * @param {number} props.index Facet index. - * @param {string} props.name Facet name. - * @param {string} props.label Facet label. - * @param {string} props.postTypes Facet post types. - * @param {'post_type'|'price_range'|'taxonomy'} props.type Facet type. + * @param {Object} props Props. + * @param {number} props.index Facet index. + * @param {string} props.name Facet name. + * @param {string} props.label Facet label. + * @param {string} props.postTypes Facet post types. + * @param {'post_type'|'price_range'|'taxonomy'} props.type Facet type. * @return {WPElement} Component element. */ export default ({ index, label, name, postTypes, type }) => { diff --git a/assets/js/instant-results/components/facets/post-type-facet.js b/assets/js/instant-results/components/facets/post-type-facet.js index a184bbdbc3..6931b56a87 100644 --- a/assets/js/instant-results/components/facets/post-type-facet.js +++ b/assets/js/instant-results/components/facets/post-type-facet.js @@ -16,9 +16,9 @@ import { ActiveContraint } from '../tools/active-constraints'; /** * Post type facet component. * - * @param {Object} props Props. + * @param {Object} props Props. * @param {boolean} props.defaultIsOpen Whether the panel is open by default. - * @param {string} props.label Facet label. + * @param {string} props.label Facet label. * @return {WPElement} Component element. */ export default ({ defaultIsOpen, label }) => { @@ -34,10 +34,10 @@ export default ({ defaultIsOpen, label }) => { /** * Create list of filter options from aggregation buckets. * - * @param {Array} options List of options. - * @param {Object} bucket Aggregation bucket. + * @param {Array} options List of options. + * @param {Object} bucket Aggregation bucket. * @param {string} bucket.key Aggregation key. - * @param {number} index Bucket index. + * @param {number} index Bucket index. * @return {Array} Array of options. */ const reduceOptions = useCallback( diff --git a/assets/js/instant-results/components/facets/price-range-facet.js b/assets/js/instant-results/components/facets/price-range-facet.js index e2bedca102..b4c87a9163 100644 --- a/assets/js/instant-results/components/facets/price-range-facet.js +++ b/assets/js/instant-results/components/facets/price-range-facet.js @@ -16,9 +16,9 @@ import { ActiveContraint } from '../tools/active-constraints'; /** * Price range facet. * - * @param {Object} props Props. + * @param {Object} props Props. * @param {boolean} props.defaultIsOpen Whether the panel is open by default. - * @param {string} props.label Facet label. + * @param {string} props.label Facet label. * @return {WPElement} Component element. */ export default ({ defaultIsOpen, label }) => { diff --git a/assets/js/instant-results/components/facets/taxonomy-terms-facet.js b/assets/js/instant-results/components/facets/taxonomy-terms-facet.js index 3271a93675..a69822f135 100644 --- a/assets/js/instant-results/components/facets/taxonomy-terms-facet.js +++ b/assets/js/instant-results/components/facets/taxonomy-terms-facet.js @@ -16,11 +16,11 @@ import { ActiveContraint } from '../tools/active-constraints'; /** * Taxonomy filter component. * - * @param {Object} props Components props. + * @param {Object} props Components props. * @param {boolean} props.defaultIsOpen Whether the panel is open by default. - * @param {string} props.label Facet label. - * @param {Array} props.postTypes Facet post types. - * @param {string} props.taxonomy Facet taxonomy. + * @param {string} props.label Facet label. + * @param {Array} props.postTypes Facet post types. + * @param {string} props.taxonomy Facet taxonomy. * @return {WPElement} Component element. */ export default ({ defaultIsOpen, label, postTypes, taxonomy }) => { @@ -60,8 +60,8 @@ export default ({ defaultIsOpen, label, postTypes, taxonomy }) => { /** * Create list of filter options from aggregation buckets. * - * @param {Array} options List of options. - * @param {Object} bucket Aggregation bucket. + * @param {Array} options List of options. + * @param {Object} bucket Aggregation bucket. * @param {string} bucket.key Aggregation key. * @return {Array} Array of options. */ @@ -91,8 +91,8 @@ export default ({ defaultIsOpen, label, postTypes, taxonomy }) => { /** * Reduce options to labels. * - * @param {Object} labels List of options. - * @param {Object} bucket Aggregation bucket. + * @param {Object} labels List of options. + * @param {Object} bucket Aggregation bucket. * @param {string} bucket.key Aggregation key. * @return {Object} Options and their labels. */ diff --git a/assets/js/instant-results/components/layout/sidebar.js b/assets/js/instant-results/components/layout/sidebar.js index e2b6cc4ef0..49229c1291 100644 --- a/assets/js/instant-results/components/layout/sidebar.js +++ b/assets/js/instant-results/components/layout/sidebar.js @@ -11,7 +11,7 @@ import Context from '../../context'; /** * Search field component. * - * @param {Object} props Props. + * @param {Object} props Props. * @param {WPElement} props.children Children. * @return {WPElement} Element. */ diff --git a/assets/js/instant-results/components/layout/toolbar.js b/assets/js/instant-results/components/layout/toolbar.js index 7be536ec7b..40aa3574f6 100644 --- a/assets/js/instant-results/components/layout/toolbar.js +++ b/assets/js/instant-results/components/layout/toolbar.js @@ -6,7 +6,7 @@ import { WPElement } from '@wordpress/element'; /** * Search field component. * - * @param {Object} props Props. + * @param {Object} props Props. * @param {WPElement} props.children Children. * @return {WPElement} Element. */ diff --git a/assets/js/instant-results/components/results/pagination.js b/assets/js/instant-results/components/results/pagination.js index 44ebbd562b..5c888e4cfe 100644 --- a/assets/js/instant-results/components/results/pagination.js +++ b/assets/js/instant-results/components/results/pagination.js @@ -6,12 +6,12 @@ import { __, sprintf } from '@wordpress/i18n'; /** * Search results component. * - * @param {Object} props Props. - * @param {number} props.offset Current items offset. - * @param {Function} props.onNext Next button handler. + * @param {Object} props Props. + * @param {number} props.offset Current items offset. + * @param {Function} props.onNext Next button handler. * @param {Function} props.onPrevious Previous button handler. - * @param {number} props.perPage Items per page. - * @param {number} props.total Total number of items. + * @param {number} props.perPage Items per page. + * @param {number} props.total Total number of items. * @return {WPElement} Element. */ export default ({ offset, onNext, onPrevious, perPage, total }) => { diff --git a/assets/js/instant-results/components/results/result.js b/assets/js/instant-results/components/results/result.js index ebe9188ac8..e385f950b6 100644 --- a/assets/js/instant-results/components/results/result.js +++ b/assets/js/instant-results/components/results/result.js @@ -15,7 +15,7 @@ const { gmdateI18n } = wp.date; /** * Search result. * - * @param {Object} props Component props. + * @param {Object} props Component props. * @param {Object} props.hit Elasticsearch hit. * @return {WPElement} Component element. */ diff --git a/assets/js/instant-results/components/tools/active-constraints.js b/assets/js/instant-results/components/tools/active-constraints.js index cf8f88c4cb..ba0eca963d 100644 --- a/assets/js/instant-results/components/tools/active-constraints.js +++ b/assets/js/instant-results/components/tools/active-constraints.js @@ -19,8 +19,8 @@ const { Fill, Slot } = createSlotFill('ActiveContraints'); /** * Active filter component. * - * @param {Object} props Props. - * @param {string} props.label Constraint label. + * @param {Object} props Props. + * @param {string} props.label Constraint label. * @param {Function} props.onClick Click handler. * @return {WPElement} Element. */ diff --git a/assets/js/instant-results/functions.js b/assets/js/instant-results/functions.js index e278504009..d44b1d871b 100644 --- a/assets/js/instant-results/functions.js +++ b/assets/js/instant-results/functions.js @@ -6,7 +6,7 @@ import { currencyCode } from './config'; /** * Format a number as a price. * - * @param {number} number Number to format. + * @param {number} number Number to format. * @param {Object} options Formatter options. * @return {string} Formatted number. */ diff --git a/assets/js/instant-results/hooks.js b/assets/js/instant-results/hooks.js index 801d32cc84..6977ed9c16 100644 --- a/assets/js/instant-results/hooks.js +++ b/assets/js/instant-results/hooks.js @@ -6,7 +6,7 @@ import { apiEndpoint, apiHost } from './config'; * after the last time it was run. * * @param {Function} callback Function to debounce. - * @param {number} delay Milliseconds to delay. + * @param {number} delay Milliseconds to delay. * @return {Function} Debounced function. */ export const useDebounce = (callback, delay) => { diff --git a/assets/js/instant-results/reducer.js b/assets/js/instant-results/reducer.js index 4046606f12..08067de9db 100644 --- a/assets/js/instant-results/reducer.js +++ b/assets/js/instant-results/reducer.js @@ -33,9 +33,9 @@ export const initialArg = { /** * Reducer function for handling state changes. * - * @param {Object} state The current state. - * @param {Object} action Action data. - * @param {string} action.type The action name. + * @param {Object} state The current state. + * @param {Object} action Action data. + * @param {string} action.type The action name. * @param {Object} action.payload New state data from the action. * @return {Object} Updated state. */ diff --git a/assets/js/sync.js b/assets/js/sync.js index 4ae689de61..d44ac2f2e1 100644 --- a/assets/js/sync.js +++ b/assets/js/sync.js @@ -257,7 +257,7 @@ if (epDash.index_meta) { * Change the disabled attribute of an element * * @param {HTMLElement} element Element to be updated - * @param {boolean} value The value used in disabled attribute + * @param {boolean} value The value used in disabled attribute */ function updateDisabledAttribute(element, value) { element.disabled = value; diff --git a/includes/classes/Command.php b/includes/classes/Command.php index 9921109577..e676ca2dea 100644 --- a/includes/classes/Command.php +++ b/includes/classes/Command.php @@ -1379,7 +1379,7 @@ public function request( $args, $assoc_args ) { add_filter( 'http_api_debug', function ( $response, $context, $transport, $request_args, $url ) { - // phpcs:disab le WordPress.PHP.DevelopmentFunctions + // phpcs:disable WordPress.PHP.DevelopmentFunctions WP_CLI::line( sprintf( /* translators: URL of the request */