mirror of
https://github.com/gosticks/wordpress-develop.git
synced 2026-08-11 20:30:23 +00:00
Docs: Document default values for optional parameters in various DocBlocks.
Props paulkevan, costdev, audrasjb, SergeyBiryukov. See #56792. git-svn-id: https://develop.svn.wordpress.org/trunk@55398 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
@@ -56,7 +56,7 @@ class WP_Error {
|
||||
*
|
||||
* @param string|int $code Error code.
|
||||
* @param string $message Error message.
|
||||
* @param mixed $data Optional. Error data.
|
||||
* @param mixed $data Optional. Error data. Default empty string.
|
||||
*/
|
||||
public function __construct( $code = '', $message = '', $data = '' ) {
|
||||
if ( empty( $code ) ) {
|
||||
@@ -103,7 +103,8 @@ class WP_Error {
|
||||
*
|
||||
* @since 2.1.0
|
||||
*
|
||||
* @param string|int $code Optional. Retrieve messages matching code, if exists.
|
||||
* @param string|int $code Optional. Error code to retrieve the messages for.
|
||||
* Default empty string.
|
||||
* @return string[] Error strings on success, or empty array if there are none.
|
||||
*/
|
||||
public function get_error_messages( $code = '' ) {
|
||||
@@ -132,7 +133,8 @@ class WP_Error {
|
||||
*
|
||||
* @since 2.1.0
|
||||
*
|
||||
* @param string|int $code Optional. Error code to retrieve message.
|
||||
* @param string|int $code Optional. Error code to retrieve the message for.
|
||||
* Default empty string.
|
||||
* @return string The error message.
|
||||
*/
|
||||
public function get_error_message( $code = '' ) {
|
||||
@@ -151,7 +153,7 @@ class WP_Error {
|
||||
*
|
||||
* @since 2.1.0
|
||||
*
|
||||
* @param string|int $code Optional. Error code.
|
||||
* @param string|int $code Optional. Error code. Default empty string.
|
||||
* @return mixed Error data, if it exists.
|
||||
*/
|
||||
public function get_error_data( $code = '' ) {
|
||||
@@ -185,7 +187,7 @@ class WP_Error {
|
||||
*
|
||||
* @param string|int $code Error code.
|
||||
* @param string $message Error message.
|
||||
* @param mixed $data Optional. Error data.
|
||||
* @param mixed $data Optional. Error data. Default empty string.
|
||||
*/
|
||||
public function add( $code, $message, $data = '' ) {
|
||||
$this->errors[ $code ][] = $message;
|
||||
|
||||
Reference in New Issue
Block a user