Ability category.
public
mixed
JPKCOM_GUTENBERG_IMG_ALT_ABILITY_CATEGORY
= 'jpkcom-media'
NOT the jpkcom-content category the three content plugins share: this reports an editorial gap in the media library, not published content, and it is gated differently. Categories are global and first-wins, so registration goes through wp_has_ability_category() either way.
Top-level input keys the ability declares.
public
mixed
JPKCOM_GUTENBERG_IMG_ALT_ABILITY_INPUT_KEYS
= ['jpkcom-gutenberg-img-alt/list-images-missing-alt' => ['page', 'per_page']]
Cross-checked against the registered schema by tests/test-abilities.php. additionalProperties is deliberately not declared on a schema that carries properties: validate_input() runs before the execute callback and would preempt the guard, replacing a message naming the accepted keys with core's "not a valid property of the object".
Highest page number accepted.
public
mixed
JPKCOM_GUTENBERG_IMG_ALT_ABILITY_PAGE_MAX
= \intdiv(num1: \PHP_INT_MAX, num2: \max(1, \JPKCOM_GUTENBERG_IMG_ALT_ABILITY_PER_PAGE_MAX))
Derived rather than picked: the offset is a plain integer multiplication, and past PHP_INT_MAX it becomes a float that collapses to 0 - handing back page one's rows labelled as a page far beyond the last.
Default page size.
public
mixed
JPKCOM_GUTENBERG_IMG_ALT_ABILITY_PER_PAGE_DEFAULT
= 20
Largest page size honoured.
public
mixed
JPKCOM_GUTENBERG_IMG_ALT_ABILITY_PER_PAGE_MAX
= 100
public
mixed
JPKCOM_GUTENBERG_IMG_ALT_VERSION
= '1.1.0'
Decide whether the ability should be registered at all.
jpkcom_gutenberg_img_alt_abilities_enabled() : bool
True when registration should proceed.
Write a debug line, and only with WP_DEBUG.
jpkcom_gutenberg_img_alt_ability_log(string $message) : void
Message.
Build a WP_Error carrying an HTTP status.
jpkcom_gutenberg_img_alt_ability_error(string $code, string $message[, int $status = 400 ]) : WP_Error
Without data['status'] rest_ensure_response() defaults to 500, and a 5xx tells an agent "transient fault, retry unchanged" - the opposite of what a caller mistake needs to hear.
Error code.
Message.
HTTP status.
Error.
Turn a Throwable out of the callback into a WP_Error.
jpkcom_gutenberg_img_alt_ability_boundary(callable $body, string $ability) : array<string, mixed>|WP_Error
Callback.
Ability name.
Result or error.
Check the capability required to run the ability.
jpkcom_gutenberg_img_alt_ability_capability(string $ability) : bool
upload_files, NOT read like the sibling content plugins. Those publish
content the site already shows to visitors; this enumerates the media
library, where file names and unattached uploads are editorial internals.
The capability that means "works with media" is the honest gate, and it
excludes subscribers.
Ability name.
True when the current user may run it.
Build the meta array for the ability.
jpkcom_gutenberg_img_alt_ability_meta(string $ability) : array<string, mixed>
All three annotations explicit: they default to null and the REST run controller derives the HTTP verb from them, so without readonly the run route would be POST-only.
Ability name.
Meta array.
Bring the value core hands the callback into array form.
jpkcom_gutenberg_img_alt_ability_normalise_input(mixed $input) : array<string, mixed>|null
normalize_input() substitutes the schema's top-level default when the input is exactly null, and that default is a stdClass - so the callback receives an object and must read it. A callback that only accepts an array answers 400 to the most obvious call it has.
Raw input.
Array form, or null when unusable.
Refuse a top-level input key the ability does not declare.
jpkcom_gutenberg_img_alt_ability_validate_input_keys(array<string, mixed> $input, array<string|int, string> $allowed) : true|WP_Error
Raw input.
Declared keys.
True when every key is declared.
Would this plugin's filter inject an alt attribute for this stored value?
jpkcom_gutenberg_img_alt_would_inject(mixed $stored) : bool
THE load-bearing function of this file, and deliberately not a paraphrase
of the rule. The filter gates on ! empty( $alt ) and the replacer then
returns the block unchanged when '' === trim( $alt ). Two consequences
follow that a reasonable-looking check would get wrong:
$alt !== '' would call that image supplied.! empty() but is stopped by the trim in
the replacer. A check that mirrored only the first gate would call that
image supplied too.Reporting an image as fine when the mechanism has nothing to inject for it is the one answer this ability must never give, because it is the answer that stops someone looking.
Raw stored alt value.
True when the filter would inject.
Name why the filter would inject nothing, so a fixer knows what is there.
jpkcom_gutenberg_img_alt_ability_reason(mixed $stored, bool $row_found) : string
Raw stored value.
Whether a meta row exists at all.
One of no_row, empty, zero, whitespace_only.
Permission callback.
jpkcom_gutenberg_img_alt_ability_permission([mixed $input = null ]) : bool
Validated input, unused.
True when the current user may run the ability.
List the image attachments the filter would find nothing to inject for.
jpkcom_gutenberg_img_alt_ability_list_inner([mixed $input = null ]) : array<string, mixed>|WP_Error
Queried with one statement rather than by walking the library in PHP: the
predicate needs TRIM(), which no meta_query comparison expresses, and a
page-by-page PHP filter would make total a guess.
Ability input.
Result.
Execute callback.
jpkcom_gutenberg_img_alt_ability_list([mixed $input = null ]) : array<string, mixed>|WP_Error
Ability input.
Result.
Build the registration arguments.
jpkcom_gutenberg_img_alt_get_ability_definitions() : array<string, array<string, mixed>>
Reads no WordPress state and touches no registry, which is what lets the CI harness assert the shape without a WordPress installation.
Ability name => registration args.
Register the category, unless something already did.
jpkcom_gutenberg_img_alt_register_ability_category() : void
Register the ability.
jpkcom_gutenberg_img_alt_register_abilities() : void
wp_register_ability() returns null on EVERY failure path and reports only through _doing_it_wrong(), which is silent in production - and so is the debug log without WP_DEBUG.
jpkcom_gutenberg_img_alt_replace_alt_attribute(string $block_content, string $alt) : string