wppaste
WordPress

form_option( string $option )

Since
1.5.0
Source
wp-includes/option.php:584
Prints option value after sanitizing for forms.

Parameters

$optionstring
Option name.

Cost profile

Measured from the compiled opcodes, not from a stopwatch. Every number here is identical on any machine that runs the same PHP version, and every function in core is ranked by these figures.

Cost class
Moderate

Reads stored settings via get_option(), cached per request but not free on a cold cache.

Scaling
Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions
9

Executed per call on PHP 8.4. The body compiles to 9.

Plugin surface
None

Nothing here hands control to plugin code.

Called by
0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

  • optionoption read or writeget_option()called directly
  • hookthird-party callbacksapply_filters()one call below form_option()
  • cacheobject cachewp_cache_get()one call below form_option()
  • serializeserialisationmaybe_unserialize()one call below form_option()

Further down the call graph this can also reach query and transient those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 1 distinct outcome

One number would be a lie: the work depends on which branch runs. These are every distinct cost form_option() can have, taken from its control-flow graph on PHP 8.4.

WhenInstructionsCalls it makes
always9get_option()esc_attr()

Across PHP versions

PHPCompiledExecutedBranchesNotes
7.4990Compiles to the same instructions
8.1990Compiles to the same instructions
8.2990Compiles to the same instructions
8.3990Compiles to the same instructions
8.4990Compiles to the same instructions

Oldest PHP that compiles this body: 7.4. An instruction is not a fixed amount of time, so a version with the same count is not necessarily the same speed; what the count rules out is a difference in the work itself.

Uses · 2

Source

function form_option( $option ) {	echo esc_attr( get_option( $option ) );}

History

Introduced in 1.5.0. Unchanged from 6.7.7 through 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data
Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/option.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
Corrections
Something wrong on this page? Report it and it gets fixed in the next regeneration.