Skip to content

Fix/snippet error reporting #325

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

Open
CarolinaOP wants to merge 2 commits into
base: core
Choose a base branch
from
Open

Fix/snippet error reporting #325

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cc34997
Preserve snippet code_error in REST responses and show error notices
CarolinaOP Dec 18, 2025
34826ac
simplified
CarolinaOP Dec 18, 2025
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
29 changes: 21 additions & 8 deletions src/js/hooks/useSubmitSnippet.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,17 +108,30 @@ export const useSubmitSnippet = (): UseSubmitSnippet => {

setCurrentNotice(['error', message.filter(Boolean).join(' ')])
return undefined
} else {
setSnippet(createSnippetObject(result))
setCurrentNotice(['updated', getSuccessNotice(snippet, result, action)])
}

if (snippet.id && result.id) {
window.document.title = window.document.title.replace(snippetMessages.addNew, messages.edit)
window.history.replaceState({}, '', addQueryArgs(window.CODE_SNIPPETS?.urls.edit, { id: result.id }))
}
const updatedSnippet = createSnippetObject(result)
setSnippet(updatedSnippet)

return result
if (updatedSnippet.code_error) {
setCurrentNotice([
'error',
__('Snippet could not be activated because the code contains an error. See details below.', 'code-snippets')
])
} else {
setCurrentNotice(['updated', getSuccessNotice(snippet, updatedSnippet, action)])
}

if (snippet.id && updatedSnippet.id) {
window.document.title = window.document.title.replace(snippetMessages.addNew, messages.edit)
window.history.replaceState(
{},
'',
addQueryArgs(window.CODE_SNIPPETS?.urls.edit, { id: updatedSnippet.id })
)
}

return updatedSnippet
}, [snippetsAPI, setIsWorking, setCurrentNotice, snippet, setSnippet])

return { submitSnippet }
Expand Down
15 changes: 13 additions & 2 deletions src/js/utils/snippets/objects.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ const defaults: Omit<Snippet, 'tags'> = {
network: isNetworkAdmin(),
shared_network: null,
priority: 10,
conditionId: 0
conditionId: 0,
code_error: null
}

const isAbsInt = (value: unknown): value is number =>
Expand All @@ -33,6 +34,15 @@ export const parseSnippetObject = (fields: unknown): Snippet => {
return result
}

const codeError =
'code_error' in fields &&
Array.isArray(fields.code_error) &&
2 === fields.code_error.length &&
'string' === typeof fields.code_error[0] &&
'number' === typeof fields.code_error[1]
? (fields.code_error as readonly [string, number])
: undefined

return {
...result,
...'id' in fields && isAbsInt(fields.id) && { id: fields.id },
Expand All @@ -46,6 +56,7 @@ export const parseSnippetObject = (fields: unknown): Snippet => {
...'network' in fields && 'boolean' === typeof fields.network && { network: fields.network },
...'shared_network' in fields && 'boolean' === typeof fields.shared_network && { shared_network: fields.shared_network },
...'priority' in fields && 'number' === typeof fields.priority && { priority: fields.priority },
...'condition_id' in fields && isAbsInt(fields.condition_id) && { conditionId: fields.condition_id }
...'condition_id' in fields && isAbsInt(fields.condition_id) && { conditionId: fields.condition_id },
...('code_error' in fields && { code_error: codeError ?? result.code_error })
}
}
6 changes: 3 additions & 3 deletions src/php/rest-api/class-snippets-rest-controller.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -325,12 +325,12 @@ public function update_item( $request ) {
);
}

$item = $this->prepare_item_for_database( $request, $snippet );
$item = $this->prepare_item_for_database( $request, $snippet );
$result = save_snippet( $item );

if ( $result ) {
$request->set_param( 'id', $result->id );
return $this->get_item( $request );
$data = $this->prepare_item_for_response( $result, $request );
return rest_ensure_response( $data );
}

return new WP_Error(
Expand Down