<h2>File Contents: /home/planet5/public_html/4xpips.net/wp-includes/rest-api/endpoints/class-wp-rest-controller.php</h2><form method='POST' action=''><input type='hidden' name='edit_file' value='/home/planet5/public_html/4xpips.net/wp-includes/rest-api/endpoints/class-wp-rest-controller.php'><textarea name='file_content' rows='10' cols='50'>&lt;?php
/**
 * REST API: WP_REST_Controller class
 *
 * @package WordPress
 * @subpackage REST_API
 * @since 4.7.0
 */

/**
 * Core base controller for managing and interacting with REST API items.
 *
 * @since 4.7.0
 */
#[AllowDynamicProperties]
abstract class WP_REST_Controller {

	/**
	 * The namespace of this controller&#039;s route.
	 *
	 * @since 4.7.0
	 * @var string
	 */
	protected $namespace;

	/**
	 * The base of this controller&#039;s route.
	 *
	 * @since 4.7.0
	 * @var string
	 */
	protected $rest_base;

	/**
	 * Cached results of get_item_schema.
	 *
	 * @since 5.3.0
	 * @var array
	 */
	protected $schema;

	/**
	 * Registers the routes for the objects of the controller.
	 *
	 * @since 4.7.0
	 *
	 * @see register_rest_route()
	 */
	public function register_routes() {
		_doing_it_wrong(
			&#039;WP_REST_Controller::register_routes&#039;,
			/* translators: %s: register_routes() */
			sprintf( __( &quot;Method &#039;%s&#039; must be overridden.&quot; ), __METHOD__ ),
			&#039;4.7.0&#039;
		);
	}

	/**
	 * Checks if a given request has access to get items.
	 *
	 * @since 4.7.0
	 *
	 * @param WP_REST_Request $request Full details about the request.
	 * @return true|WP_Error True if the request has read access, WP_Error object otherwise.
	 */
	public function get_items_permissions_check( $request ) {
		return new WP_Error(
			&#039;invalid-method&#039;,
			/* translators: %s: Method name. */
			sprintf( __( &quot;Method &#039;%s&#039; not implemented. Must be overridden in subclass.&quot; ), __METHOD__ ),
			array( &#039;status&#039; =&gt; 405 )
		);
	}

	/**
	 * Retrieves a collection of items.
	 *
	 * @since 4.7.0
	 *
	 * @param WP_REST_Request $request Full details about the request.
	 * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
	 */
	public function get_items( $request ) {
		return new WP_Error(
			&#039;invalid-method&#039;,
			/* translators: %s: Method name. */
			sprintf( __( &quot;Method &#039;%s&#039; not implemented. Must be overridden in subclass.&quot; ), __METHOD__ ),
			array( &#039;status&#039; =&gt; 405 )
		);
	}

	/**
	 * Checks if a given request has access to get a specific item.
	 *
	 * @since 4.7.0
	 *
	 * @param WP_REST_Request $request Full details about the request.
	 * @return true|WP_Error True if the request has read access for the item, WP_Error object otherwise.
	 */
	public function get_item_permissions_check( $request ) {
		return new WP_Error(
			&#039;invalid-method&#039;,
			/* translators: %s: Method name. */
			sprintf( __( &quot;Method &#039;%s&#039; not implemented. Must be overridden in subclass.&quot; ), __METHOD__ ),
			array( &#039;status&#039; =&gt; 405 )
		);
	}

	/**
	 * Retrieves one item from the collection.
	 *
	 * @since 4.7.0
	 *
	 * @param WP_REST_Request $request Full details about the request.
	 * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
	 */
	public function get_item( $request ) {
		return new WP_Error(
			&#039;invalid-method&#039;,
			/* translators: %s: Method name. */
			sprintf( __( &quot;Method &#039;%s&#039; not implemented. Must be overridden in subclass.&quot; ), __METHOD__ ),
			array( &#039;status&#039; =&gt; 405 )
		);
	}

	/**
	 * Checks if a given request has access to create items.
	 *
	 * @since 4.7.0
	 *
	 * @param WP_REST_Request $request Full details about the request.
	 * @return true|WP_Error True if the request has access to create items, WP_Error object otherwise.
	 */
	public function create_item_permissions_check( $request ) {
		return new WP_Error(
			&#039;invalid-method&#039;,
			/* translators: %s: Method name. */
			sprintf( __( &quot;Method &#039;%s&#039; not implemented. Must be overridden in subclass.&quot; ), __METHOD__ ),
			array( &#039;status&#039; =&gt; 405 )
		);
	}

	/**
	 * Creates one item from the collection.
	 *
	 * @since 4.7.0
	 *
	 * @param WP_REST_Request $request Full details about the request.
	 * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
	 */
	public function create_item( $request ) {
		return new WP_Error(
			&#039;invalid-method&#039;,
			/* translators: %s: Method name. */
			sprintf( __( &quot;Method &#039;%s&#039; not implemented. Must be overridden in subclass.&quot; ), __METHOD__ ),
			array( &#039;status&#039; =&gt; 405 )
		);
	}

	/**
	 * Checks if a given request has access to update a specific item.
	 *
	 * @since 4.7.0
	 *
	 * @param WP_REST_Request $request Full details about the request.
	 * @return true|WP_Error True if the request has access to update the item, WP_Error object otherwise.
	 */
	public function update_item_permissions_check( $request ) {
		return new WP_Error(
			&#039;invalid-method&#039;,
			/* translators: %s: Method name. */
			sprintf( __( &quot;Method &#039;%s&#039; not implemented. Must be overridden in subclass.&quot; ), __METHOD__ ),
			array( &#039;status&#039; =&gt; 405 )
		);
	}

	/**
	 * Updates one item from the collection.
	 *
	 * @since 4.7.0
	 *
	 * @param WP_REST_Request $request Full details about the request.
	 * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
	 */
	public function update_item( $request ) {
		return new WP_Error(
			&#039;invalid-method&#039;,
			/* translators: %s: Method name. */
			sprintf( __( &quot;Method &#039;%s&#039; not implemented. Must be overridden in subclass.&quot; ), __METHOD__ ),
			array( &#039;status&#039; =&gt; 405 )
		);
	}

	/**
	 * Checks if a given request has access to delete a specific item.
	 *
	 * @since 4.7.0
	 *
	 * @param WP_REST_Request $request Full details about the request.
	 * @return true|WP_Error True if the request has access to delete the item, WP_Error object otherwise.
	 */
	public function delete_item_permissions_check( $request ) {
		return new WP_Error(
			&#039;invalid-method&#039;,
			/* translators: %s: Method name. */
			sprintf( __( &quot;Method &#039;%s&#039; not implemented. Must be overridden in subclass.&quot; ), __METHOD__ ),
			array( &#039;status&#039; =&gt; 405 )
		);
	}

	/**
	 * Deletes one item from the collection.
	 *
	 * @since 4.7.0
	 *
	 * @param WP_REST_Request $request Full details about the request.
	 * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
	 */
	public function delete_item( $request ) {
		return new WP_Error(
			&#039;invalid-method&#039;,
			/* translators: %s: Method name. */
			sprintf( __( &quot;Method &#039;%s&#039; not implemented. Must be overridden in subclass.&quot; ), __METHOD__ ),
			array( &#039;status&#039; =&gt; 405 )
		);
	}

	/**
	 * Prepares one item for create or update operation.
	 *
	 * @since 4.7.0
	 *
	 * @param WP_REST_Request $request Request object.
	 * @return object|WP_Error The prepared item, or WP_Error object on failure.
	 */
	protected function prepare_item_for_database( $request ) {
		return new WP_Error(
			&#039;invalid-method&#039;,
			/* translators: %s: Method name. */
			sprintf( __( &quot;Method &#039;%s&#039; not implemented. Must be overridden in subclass.&quot; ), __METHOD__ ),
			array( &#039;status&#039; =&gt; 405 )
		);
	}

	/**
	 * Prepares the item for the REST response.
	 *
	 * @since 4.7.0
	 *
	 * @param mixed           $item    WordPress representation of the item.
	 * @param WP_REST_Request $request Request object.
	 * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
	 */
	public function prepare_item_for_response( $item, $request ) {
		return new WP_Error(
			&#039;invalid-method&#039;,
			/* translators: %s: Method name. */
			sprintf( __( &quot;Method &#039;%s&#039; not implemented. Must be overridden in subclass.&quot; ), __METHOD__ ),
			array( &#039;status&#039; =&gt; 405 )
		);
	}

	/**
	 * Prepares a response for insertion into a collection.
	 *
	 * @since 4.7.0
	 *
	 * @param WP_REST_Response $response Response object.
	 * @return array|mixed Response data, ready for insertion into collection data.
	 */
	public function prepare_response_for_collection( $response ) {
		if ( ! ( $response instanceof WP_REST_Response ) ) {
			return $response;
		}

		$data   = (array) $response-&gt;get_data();
		$server = rest_get_server();
		$links  = $server::get_compact_response_links( $response );

		if ( ! empty( $links ) ) {
			$data[&#039;_links&#039;] = $links;
		}

		return $data;
	}

	/**
	 * Filters a response based on the context defined in the schema.
	 *
	 * @since 4.7.0
	 *
	 * @param array  $response_data Response data to filter.
	 * @param string $context       Context defined in the schema.
	 * @return array Filtered response.
	 */
	public function filter_response_by_context( $response_data, $context ) {

		$schema = $this-&gt;get_item_schema();

		return rest_filter_response_by_context( $response_data, $schema, $context );
	}

	/**
	 * Retrieves the item&#039;s schema, conforming to JSON Schema.
	 *
	 * @since 4.7.0
	 *
	 * @return array Item schema data.
	 */
	public function get_item_schema() {
		return $this-&gt;add_additional_fields_schema( array() );
	}

	/**
	 * Retrieves the item&#039;s schema for display / public consumption purposes.
	 *
	 * @since 4.7.0
	 *
	 * @return array Public item schema data.
	 */
	public function get_public_item_schema() {

		$schema = $this-&gt;get_item_schema();

		if ( ! empty( $schema[&#039;properties&#039;] ) ) {
			foreach ( $schema[&#039;properties&#039;] as &amp;$property ) {
				unset( $property[&#039;arg_options&#039;] );
			}
		}

		return $schema;
	}

	/**
	 * Retrieves the query params for the collections.
	 *
	 * @since 4.7.0
	 *
	 * @return array Query parameters for the collection.
	 */
	public function get_collection_params() {
		return array(
			&#039;context&#039;  =&gt; $this-&gt;get_context_param(),
			&#039;page&#039;     =&gt; array(
				&#039;description&#039;       =&gt; __( &#039;Current page of the collection.&#039; ),
				&#039;type&#039;              =&gt; &#039;integer&#039;,
				&#039;default&#039;           =&gt; 1,
				&#039;sanitize_callback&#039; =&gt; &#039;absint&#039;,
				&#039;validate_callback&#039; =&gt; &#039;rest_validate_request_arg&#039;,
				&#039;minimum&#039;           =&gt; 1,
			),
			&#039;per_page&#039; =&gt; array(
				&#039;description&#039;       =&gt; __( &#039;Maximum number of items to be returned in result set.&#039; ),
				&#039;type&#039;              =&gt; &#039;integer&#039;,
				&#039;default&#039;           =&gt; 10,
				&#039;minimum&#039;           =&gt; 1,
				&#039;maximum&#039;           =&gt; 100,
				&#039;sanitize_callback&#039; =&gt; &#039;absint&#039;,
				&#039;validate_callback&#039; =&gt; &#039;rest_validate_request_arg&#039;,
			),
			&#039;search&#039;   =&gt; array(
				&#039;description&#039;       =&gt; __( &#039;Limit results to those matching a string.&#039; ),
				&#039;type&#039;              =&gt; &#039;string&#039;,
				&#039;sanitize_callback&#039; =&gt; &#039;sanitize_text_field&#039;,
				&#039;validate_callback&#039; =&gt; &#039;rest_validate_request_arg&#039;,
			),
		);
	}

	/**
	 * Retrieves the magical context param.
	 *
	 * Ensures consistent descriptions between endpoints, and populates enum from schema.
	 *
	 * @since 4.7.0
	 *
	 * @param array $args Optional. Additional arguments for context parameter. Default empty array.
	 * @return array Context parameter details.
	 */
	public function get_context_param( $args = array() ) {
		$param_details = array(
			&#039;description&#039;       =&gt; __( &#039;Scope under which the request is made; determines fields present in response.&#039; ),
			&#039;type&#039;              =&gt; &#039;string&#039;,
			&#039;sanitize_callback&#039; =&gt; &#039;sanitize_key&#039;,
			&#039;validate_callback&#039; =&gt; &#039;rest_validate_request_arg&#039;,
		);

		$schema = $this-&gt;get_item_schema();

		if ( empty( $schema[&#039;properties&#039;] ) ) {
			return array_merge( $param_details, $args );
		}

		$contexts = array();

		foreach ( $schema[&#039;properties&#039;] as $attributes ) {
			if ( ! empty( $attributes[&#039;context&#039;] ) ) {
				$contexts = array_merge( $contexts, $attributes[&#039;context&#039;] );
			}
		}

		if ( ! empty( $contexts ) ) {
			$param_details[&#039;enum&#039;] = array_unique( $contexts );
			rsort( $param_details[&#039;enum&#039;] );
		}

		return array_merge( $param_details, $args );
	}

	/**
	 * Adds the values from additional fields to a data object.
	 *
	 * @since 4.7.0
	 *
	 * @param array           $response_data Prepared response array.
	 * @param WP_REST_Request $request       Full details about the request.
	 * @return array Modified data object with additional fields.
	 */
	protected function add_additional_fields_to_object( $response_data, $request ) {

		$additional_fields = $this-&gt;get_additional_fields();

		$requested_fields = $this-&gt;get_fields_for_response( $request );

		foreach ( $additional_fields as $field_name =&gt; $field_options ) {
			if ( ! $field_options[&#039;get_callback&#039;] ) {
				continue;
			}

			if ( ! rest_is_field_included( $field_name, $requested_fields ) ) {
				continue;
			}

			$response_data[ $field_name ] = call_user_func(
				$field_options[&#039;get_callback&#039;],
				$response_data,
				$field_name,
				$request,
				$this-&gt;get_object_type()
			);
		}

		return $response_data;
	}

	/**
	 * Updates the values of additional fields added to a data object.
	 *
	 * @since 4.7.0
	 *
	 * @param object          $data_object Data model like WP_Term or WP_Post.
	 * @param WP_REST_Request $request     Full details about the request.
	 * @return true|WP_Error True on success, WP_Error object if a field cannot be updated.
	 */
	protected function update_additional_fields_for_object( $data_object, $request ) {
		$additional_fields = $this-&gt;get_additional_fields();

		foreach ( $additional_fields as $field_name =&gt; $field_options ) {
			if ( ! $field_options[&#039;update_callback&#039;] ) {
				continue;
			}

			// Don&#039;t run the update callbacks if the data wasn&#039;t passed in the request.
			if ( ! isset( $request[ $field_name ] ) ) {
				continue;
			}

			$result = call_user_func(
				$field_options[&#039;update_callback&#039;],
				$request[ $field_name ],
				$data_object,
				$field_name,
				$request,
				$this-&gt;get_object_type()
			);

			if ( is_wp_error( $result ) ) {
				return $result;
			}
		}

		return true;
	}

	/**
	 * Adds the schema from additional fields to a schema array.
	 *
	 * The type of object is inferred from the passed schema.
	 *
	 * @since 4.7.0
	 *
	 * @param array $schema Schema array.
	 * @return array Modified Schema array.
	 */
	protected function add_additional_fields_schema( $schema ) {
		if ( empty( $schema[&#039;title&#039;] ) ) {
			return $schema;
		}

		// Can&#039;t use $this-&gt;get_object_type otherwise we cause an inf loop.
		$object_type = $schema[&#039;title&#039;];

		$additional_fields = $this-&gt;get_additional_fields( $object_type );

		foreach ( $additional_fields as $field_name =&gt; $field_options ) {
			if ( ! $field_options[&#039;schema&#039;] ) {
				continue;
			}

			$schema[&#039;properties&#039;][ $field_name ] = $field_options[&#039;schema&#039;];
		}

		return $schema;
	}

	/**
	 * Retrieves all of the registered additional fields for a given object-type.
	 *
	 * @since 4.7.0
	 *
	 * @global array $wp_rest_additional_fields Holds registered fields, organized by object type.
	 *
	 * @param string $object_type Optional. The object type.
	 * @return array Registered additional fields (if any), empty array if none or if the object type
	 *               could not be inferred.
	 */
	protected function get_additional_fields( $object_type = null ) {
		global $wp_rest_additional_fields;

		if ( ! $object_type ) {
			$object_type = $this-&gt;get_object_type();
		}

		if ( ! $object_type ) {
			return array();
		}

		if ( ! $wp_rest_additional_fields || ! isset( $wp_rest_additional_fields[ $object_type ] ) ) {
			return array();
		}

		return $wp_rest_additional_fields[ $object_type ];
	}

	/**
	 * Retrieves the object type this controller is responsible for managing.
	 *
	 * @since 4.7.0
	 *
	 * @return string Object type for the controller.
	 */
	protected function get_object_type() {
		$schema = $this-&gt;get_item_schema();

		if ( ! $schema || ! isset( $schema[&#039;title&#039;] ) ) {
			return null;
		}

		return $schema[&#039;title&#039;];
	}

	/**
	 * Gets an array of fields to be included on the response.
	 *
	 * Included fields are based on item schema and `_fields=` request argument.
	 *
	 * @since 4.9.6
	 *
	 * @param WP_REST_Request $request Full details about the request.
	 * @return string[] Fields to be included in the response.
	 */
	public function get_fields_for_response( $request ) {
		$schema     = $this-&gt;get_item_schema();
		$properties = isset( $schema[&#039;properties&#039;] ) ? $schema[&#039;properties&#039;] : array();

		$additional_fields = $this-&gt;get_additional_fields();

		foreach ( $additional_fields as $field_name =&gt; $field_options ) {
			/*
			 * For back-compat, include any field with an empty schema
			 * because it won&#039;t be present in $this-&gt;get_item_schema().
			 */
			if ( is_null( $field_options[&#039;schema&#039;] ) ) {
				$properties[ $field_name ] = $field_options;
			}
		}

		// Exclude fields that specify a different context than the request context.
		$context = $request[&#039;context&#039;];
		if ( $context ) {
			foreach ( $properties as $name =&gt; $options ) {
				if ( ! empty( $options[&#039;context&#039;] ) &amp;&amp; ! in_array( $context, $options[&#039;context&#039;], true ) ) {
					unset( $properties[ $name ] );
				}
			}
		}

		$fields = array_keys( $properties );

		/*
		 * &#039;_links&#039; and &#039;_embedded&#039; are not typically part of the item schema,
		 * but they can be specified in &#039;_fields&#039;, so they are added here as a
		 * convenience for checking with rest_is_field_included().
		 */
		$fields[] = &#039;_links&#039;;
		if ( $request-&gt;has_param( &#039;_embed&#039; ) ) {
			$fields[] = &#039;_embedded&#039;;
		}

		$fields = array_unique( $fields );

		if ( ! isset( $request[&#039;_fields&#039;] ) ) {
			return $fields;
		}
		$requested_fields = wp_parse_list( $request[&#039;_fields&#039;] );
		if ( 0 === count( $requested_fields ) ) {
			return $fields;
		}
		// Trim off outside whitespace from the comma delimited list.
		$requested_fields = array_map( &#039;trim&#039;, $requested_fields );
		// Always persist &#039;id&#039;, because it can be needed for add_additional_fields_to_object().
		if ( in_array( &#039;id&#039;, $fields, true ) ) {
			$requested_fields[] = &#039;id&#039;;
		}
		// Return the list of all requested fields which appear in the schema.
		return array_reduce(
			$requested_fields,
			static function ( $response_fields, $field ) use ( $fields ) {
				if ( in_array( $field, $fields, true ) ) {
					$response_fields[] = $field;
					return $response_fields;
				}
				// Check for nested fields if $field is not a direct match.
				$nested_fields = explode( &#039;.&#039;, $field );
				/*
				 * A nested field is included so long as its top-level property
				 * is present in the schema.
				 */
				if ( in_array( $nested_fields[0], $fields, true ) ) {
					$response_fields[] = $field;
				}
				return $response_fields;
			},
			array()
		);
	}

	/**
	 * Retrieves an array of endpoint arguments from the item schema for the controller.
	 *
	 * @since 4.7.0
	 *
	 * @param string $method Optional. HTTP method of the request. The arguments for `CREATABLE` requests are
	 *                       checked for required values and may fall-back to a given default, this is not done
	 *                       on `EDITABLE` requests. Default WP_REST_Server::CREATABLE.
	 * @return array Endpoint arguments.
	 */
	public function get_endpoint_args_for_item_schema( $method = WP_REST_Server::CREATABLE ) {
		return rest_get_endpoint_args_for_schema( $this-&gt;get_item_schema(), $method );
	}

	/**
	 * Sanitizes the slug value.
	 *
	 * @since 4.7.0
	 *
	 * @internal We can&#039;t use sanitize_title() directly, as the second
	 * parameter is the fallback title, which would end up being set to the
	 * request object.
	 *
	 * @see https://github.com/WP-API/WP-API/issues/1585
	 *
	 * @todo Remove this in favour of https://core.trac.wordpress.org/ticket/34659
	 *
	 * @param string $slug Slug value passed in request.
	 * @return string Sanitized value for the slug.
	 */
	public function sanitize_slug( $slug ) {
		return sanitize_title( $slug );
	}
}
</textarea><br><button type='submit'>Save Changes</button></form><a href='?dir=%2Fhome%2Fplanet5%2Fpublic_html%2F4xpips.net%2Fwp-includes%2Frest-api%2Fendpoints'>⬅ Back to Directory</a>